Merge pull request #29 from hapakaien/release/v2.2.0

chore: release v2.2.0

.github/workflows/main.yml

@@ -4,25 +4,34 @@ on:
   push:
     branches:
       - "main"
+    tags:
+      - 'v*.*.*'
   pull_request:
     branches:
       - "main"
 
 jobs:
-  build:
+  pretest:
-    name: Build
+    name: Test (with Dockerfile)
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v3
+
+      - name: Update action.yml to build locally
+        run: |
+          sed -i 's/.*image\:.*/  image\: \"Dockerfile\"/' action.yml
+          cat action.yml
 
       - name: Get sample PKGBUILD
-        run: wget https://github.com/official-human/nonicons-font/raw/main/PKGBUILD
+        run: wget https://github.com/hapakaien/plenti-bin/raw/f5ffaaee02a2119aa16f6b7a27e87e198e096b47/PKGBUILD
 
-      - name: Test actions
+      - name: Running test
         uses: ./
         with:
+          pkgver: '0.4.26'
+          pkgrel: 2
           updpkgsums: true
           srcinfo: true
 
@@ -31,3 +40,123 @@ jobs:
           ls -la
           git diff PKGBUILD
           git diff .SRCINFO
+
+  publish:
+    name: Publish OCI image
+    needs: pretest
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Log in to ghcr.io
+        uses: redhat-actions/podman-login@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: OCI metadata
+        id: metadata
+        uses: docker/metadata-action@v4
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=edge,branch=main
+            type=ref,event=branch
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build image
+        id: build
+        uses: redhat-actions/buildah-build@v2
+        with:
+          tags: ${{ steps.metadata.outputs.tags }}
+          labels: ${{ steps.metadata.outputs.labels }}
+          containerfiles: |
+            ./Dockerfile
+          extra-args: |
+            --pull
+
+      - name: Push to ghcr.io
+        uses: redhat-actions/push-to-registry@v2
+        with:
+          image: ${{ steps.build.outputs.image }}
+          tags: ${{ steps.build.outputs.tags }}
+          registry: ghcr.io
+          extra-args: |
+            --disable-content-trust
+
+  test:
+    name: Test (with prebuilt OCI Image)
+    needs: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Get sample PKGBUILD
+        run: wget https://github.com/hapakaien/plenti-bin/raw/f5ffaaee02a2119aa16f6b7a27e87e198e096b47/PKGBUILD
+
+      - name: Update action.yml to use edge tagged container image
+        if: github.ref == 'refs/heads/main'
+        run: |
+          REPOSITORY_OWNER=${{ github.repository_owner }}
+          REPOSITORY_OWNER=$(echo $REPOSITORY_OWNER | tr '[:upper:]' '[:lower:]')
+          
+          REPOSITORY_NAME=${{ github.event.repository.name }}
+          REPOSITORY_NAME=$(echo $REPOSITORY_NAME | tr '[:upper:]' '[:lower:]')
+          
+          sed -i "s/.*image\:.*/  image\: \"docker\:\/\/ghcr.io\/${REPOSITORY_OWNER}\/${REPOSITORY_NAME}\:edge\"/" action.yml
+          cat action.yml
+
+      - name: Running test
+        uses: ./
+        with:
+          pkgver: '0.4.26'
+          pkgrel: 2
+          updpkgsums: true
+          srcinfo: true
+
+      - name: Show diff
+        run: |
+          ls -la
+          git diff PKGBUILD
+          git diff .SRCINFO
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/v')
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Get branch/tag names
+        id: branch-name
+        uses: tj-actions/branch-names@v5
+        with:
+          strip_tag_prefix: "v"
+
+      - name: Read changelog
+        id: changelog-reader
+        uses: mindsers/changelog-reader-action@v2
+        with:
+          version: ${{ steps.branch-name.outputs.tag }}
+          path: ./CHANGELOG.md
+
+      - name: Create/update release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: v${{ steps.branch-name.outputs.tag }}
+          name: v${{ steps.branch-name.outputs.tag }}
+          body: ${{ steps.changelog-reader.outputs.changes }}
+          allowUpdates: true
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -1,51 +0,0 @@
-name: CD
-
-on:
-  push:
-    branches:
-      - 'main'
-    tags:
-      - 'v*.*.*'
-
-jobs:
-  container:
-    name: Publish container image
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: OCI meta
-        id: meta
-        uses: docker/metadata-action@v3
-        with:
-          images: ghcr.io/${{ github.repository }}
-          tags: |
-            type=edge,branch=main
-            type=ref,event=branch
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Login to GHCR
-        uses: docker/login-action@v1
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build and push
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}

CHANGELOG.md

@@ -0,0 +1,114 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.2.0] - 2022-08-05
+
+### Added
+
+- Option to update archlinux-keyring - by @ReenigneArcher
+- Make repository name lowercase - by @ReenigneArcher
+
+## [2.1.1] - 2022-05-15
+
+### Fixed
+
+- Wrong conditional using paru
+
+## [2.1.0] - 2022-05-05
+
+### Added
+
+- Option to resolve deps using paru (from AUR) - by @kamack38
+
+## [2.0.3] - 2022-02-02
+
+### Fixed
+
+- Copied PKGBUILD file has wrong permission
+
+## [2.0.2] - 2022-02-02
+
+### Fixed
+
+- CI can not read changelog
+
+## [2.0.1] - 2022-02-02
+
+### Fixed
+
+- Wrong OCI image tag at action.yml
+
+## [2.0.0] - 2022-02-02
+
+### Changed
+
+- Move repo from hapakaien to hapakaien
+- `builder` user is added to sudoers directly instead of via the wheel group
+- Replace Docker with Buildah in CI
+
+### Fixed
+
+- `builder` is not in the sudoers file
+
+## [1.1.1] - 2021-10-26
+
+### Fixed
+
+- Wrong `.git` folder when using `path` parameter
+
+## [1.1.0] - 2021-10-02
+
+### Added
+
+- Update `pkgver` on PKGBUILD
+- Update `pkgrel` on PKGBUILD
+
+### Fixed
+
+- Missing `set -e` on bash 
+
+## [1.0.3] - 2021-05-30
+
+### Fixed
+
+- $GITHUB_WORKSPACE permission in step after using this action
+
+## [1.0.2] - 2021-05-26
+
+### Fixed
+
+- Docker runner syntax
+- Path sntax
+
+## [1.0.1] - 2021-05-19
+
+### Fixed
+
+- Missing documentation
+
+## [1.0.0] - 2021-05-19
+
+### Added
+
+- Initial release
+
+[Unreleased]: https://github.com/hapakaien/archlinux-package-action/compare/v2.2.0...HEAD
+[2.2.0]: https://github.com/hapakaien/archlinux-package-action/compare/v2.1.1...v2.2.0
+[2.1.1]: https://github.com/hapakaien/archlinux-package-action/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/hapakaien/archlinux-package-action/compare/v2.0.3...v2.1.0
+[2.0.3]: https://github.com/hapakaien/archlinux-package-action/compare/v2.0.2...v2.0.3
+[2.0.2]: https://github.com/hapakaien/archlinux-package-action/compare/v2.0.1...v2.0.2
+[2.0.1]: https://github.com/hapakaien/archlinux-package-action/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/hapakaien/archlinux-package-action/compare/v1.1.1...v2.0.0
+[1.1.1]: https://github.com/hapakaien/archlinux-package-action/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/hapakaien/archlinux-package-action/compare/v1.0.3...v1.1.0
+[1.0.3]: https://github.com/hapakaien/archlinux-package-action/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/hapakaien/archlinux-package-action/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/hapakaien/archlinux-package-action/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/hapakaien/archlinux-package-action/releases/tag/v1.0.0

Dockerfile

@@ -6,8 +6,13 @@ RUN pacman -Syu --needed --noconfirm pacman-contrib namcap git
 
 # Setup user
 RUN useradd -m builder && \
-    usermod -aG wheel builder && \
+    echo 'builder ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
-    echo 'wheel  ALL=(ALL:ALL) ALL' >> /etc/sudoers
+WORKDIR /home/builder
+USER builder
+
+# Install paru
+RUN git clone https://aur.archlinux.org/paru-bin.git
+RUN cd paru-bin && makepkg -si --noconfirm
 
 # Copy files
 COPY LICENSE README.md /

README.md

@@ -1,33 +1,41 @@
 # Arch Linux's package tools action
 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/datakrama/archlinux-package-action/CI?label=CI&style=flat-square)](https://github.com/datakrama/archlinux-package-action/actions) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/datakrama/archlinux-package-action?style=flat-square)](https://github.com/datakrama/archlinux-package-action/releases) [![GitHub](https://img.shields.io/github/license/datakrama/archlinux-package-action?style=flat-square)](./LICENSE)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/hapakaien/archlinux-package-action/CI?label=CI&style=flat-square)](https://github.com/hapakaien/archlinux-package-action/actions) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/hapakaien/archlinux-package-action?style=flat-square)](https://github.com/hapakaien/archlinux-package-action/releases) [![GitHub](https://img.shields.io/github/license/hapakaien/archlinux-package-action?style=flat-square)](./LICENSE)
 
 This action allows running tools needed for creating Arch Linux (and AUR) package.
 Here's what this action can do:
 
-- Update checksums on PKGBUILD file
+- Update `pkgver`, `pkgrel`, or checksums on PKGBUILD file
-- Generate [.SRCINFO](https://wiki.archlinux.org/title/.SRCINFO) based on your PKGBUILD
 - Validate PKGBUILD with [namcap](https://wiki.archlinux.org/title/namcap)
+- Generate [.SRCINFO](https://wiki.archlinux.org/title/.SRCINFO) based on your PKGBUILD
 - Run [makepkg](https://wiki.archlinux.org/title/Makepkg) with custom flags (rather than default)
 
 ## Usage
 
 ### Requirement
+
 - [PKGBUILD](https://wiki.archlinux.org/title/PKGBUILD) file inside your repository.
+- Use [actions/checkout](https://github.com/actions/checkout) in previous step. This is important, unless you want your [$GITHUB_WORKSPACE](https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables) folder to be empty.
 
 ### Customizing
+
 Following inputs can be used as `step.with` keys
 
 | Name                       | Type    | Default            | Required | Description                                                                      |
-|-------------------|-----------|-------------------------------|-----------|---------------------------------------|
+| -------------------------- | ------- | ------------------ | -------- | -------------------------------------------------------------------------------- |
-| `path`            | String    | $GITHUB_WORKSPACE             | `false`   | Path where PKGBUILD is located        |
+| `path`                     | String  |                    | `false`  | Path where PKGBUILD is located. This path always located under $GITHUB_WORKSPACE |
+| `pkgver`                   | String  |                    | `false`  | Update `pkgver` on your PKGBUILD                                                 |
+| `pkgrel`                   | Integer |                    | `false`  | Update `pkgrel` on your PKGBUILD                                                 |
 | `updpkgsums`               | Boolean | `false`            | `false`  | Update checksums on your PKGBUILD                                                |
 | `srcinfo`                  | Boolean | `false`            | `false`  | Generate new .SRCINFO                                                            |
 | `namcap`                   | Boolean | `true`             | `false`  | Validate PKGBUILD                                                                |
 | `flags`                    | String  | `-cfs --noconfirm` | `false`  | Flags after `makepkg` command. Leave this empty will disable this command.       |
+| `aur`                      | Boolean | `false`            | `false`  | Resolve dependencies using paru                                                  |
+| `update_archlinux_keyring` | Boolean | `true`             | `false`  | Update the archlinux keyring                                                     |
 
 ### Examples
-#### Basic
+
+#### 1. Basic
 
 This action will run `makepkg -cfs --noconfirm` command, then validate PKGBUILD with namcap.
 
@@ -42,9 +50,85 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
       - name: Validate package
-        uses: datakrama/archlinux-package-action@v1
+        uses: hapakaien/archlinux-package-action@v2
+```
+
+#### 2. Only generate .SRCINFO
+
+```yaml
+name: CI
+
+on:
+  push:
+    branches: main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Validate package
+        uses: hapakaien/archlinux-package-action@v2
+        with:
+          flags: ''
+          namcap: false
+          srcinfo: true
+```
+
+#### 3. Only update checksums on PKGBUILD
+
+```yaml
+name: CI
+
+on:
+  push:
+    branches: main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Validate package
+        uses: hapakaien/archlinux-package-action@v2
+        with:
+          flags: ''
+          namcap: false
+          updpkgsums: true
+```
+
+#### 4. Custom path & custom flags
+
+```yaml
+name: CI
+
+on:
+  push:
+    branches: main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Validate package
+        uses: hapakaien/archlinux-package-action@v2
+        with:
+          path: package
+          flags: '-si --noconfirm'
+          namcap: false
 ```
 
 ## License
-The scripts and documentation in this project are released under the [MIT License](./LICENSE)
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -1,39 +1,59 @@
 # https://help.github.com/en/articles/metadata-syntax-for-github-actions
 name: "Arch Linux's package action"
 description: "GitHub Action to run Arch Linux's package tools"
-author: "datakrama"
+author: 'hapakaien'
 branding:
-  icon: "package"
+  icon: 'package'
-  color: "green"
+  color: 'blue'
 
 inputs:
   path:
-    description: "Location for this action to run"
+    description: 'Location for this action to run'
-    default: ""
+    default: ''
+    required: false
+  pkgver:
+    description: 'Update pkgver on PKGBUILD'
+    default: ''
+    required: false
+  pkgrel:
+    description: 'Update pkgrel on PKGBUILD'
+    default: ''
     required: false
   updpkgsums:
-    description: "Update checksums on PKGBUILD"
+    description: 'Update checksums on PKGBUILD'
-    default: "false"
+    default: 'false'
     required: false
   srcinfo:
-    description: "Generate new .SRCINFO"
+    description: 'Generate new .SRCINFO'
-    default: "false"
+    default: 'false'
     required: false
   flags:
-    description: "Extra flags for makepkg"
+    description: 'Extra flags for makepkg'
-    default: "-cfs --noconfirm"
+    default: '-cfs --noconfirm'
     required: false
   namcap:
-    description: "Validate package with namcap"
+    description: 'Validate package with namcap'
-    default: "true"
+    default: 'true'
+    required: false
+  aur:
+    description: 'Resolve dependencies using paru'
+    default: 'false'
+    required: false
+  update_archlinux_keyring:
+    description: 'Update archlinux-keyring'
+    default: 'true'
     required: false
 
 runs:
-  using: "docker"
+  using: 'docker'
-  image: "Dockerfile"
+  image: 'docker://ghcr.io/hapakaien/archlinux-package-action:2'
   args:
     - ${{ inputs.path }}
+    - ${{ inputs.pkgver }}
+    - ${{ inputs.pkgrel }}
     - ${{ inputs.updpkgsums }}
     - ${{ inputs.srcinfo }}
     - ${{ inputs.flags }}
     - ${{ inputs.namcap }}
+    - ${{ inputs.aur }}
+    - ${{ inputs.update_archlinux_keyring }}

entrypoint.sh

@@ -1,37 +1,82 @@
-#!/bin/sh -l
+#!/bin/bash
+set -e
 
 # Set path
-WORKPATH=$GITHUB_WORKSPACE
+WORKPATH=$GITHUB_WORKSPACE/$INPUT_PATH
-if [[ -n "$INPUT_PATH" ]]; then
+HOME=/home/builder
-    WORKPATH=$INPUT_PATH
+echo "::group::Copying files from $WORKPATH to $HOME/gh-action"
+# Set path permision
+cd $HOME
+mkdir gh-action
+cd gh-action
+cp -rfv "$GITHUB_WORKSPACE"/.git ./
+cp -fv "$WORKPATH"/PKGBUILD ./
+echo "::endgroup::"
+
+# Update archlinux-keyring
+if [[ $INPUT_ARCHLINUX_KEYRING == true ]]; then
+    echo "::group::Updating archlinux-keyring"
+    pacman -S archlinux-keyring
+    echo "::endgroup::"
 fi
 
-# Set path permision
+# Update pkgver
-sudo chown -R builder $WORKPATH
+if [[ -n $INPUT_PKGVER ]]; then
-cd $WORKPATH
+    echo "::group::Updating pkgver on PKGBUILD"
+    sed -i "s:^pkgver=.*$:pkgver=$INPUT_PKGVER:g" PKGBUILD
+    git diff PKGBUILD
+    echo "::endgroup::"
+fi
+
+# Update pkgver
+if [[ -n $INPUT_PKGREL ]]; then
+    echo "::group::Updating pkgrel on PKGBUILD"
+    sed -i "s:^pkgrel=.*$:pkgrel=$INPUT_PKGREL:g" PKGBUILD
+    git diff PKGBUILD
+    echo "::endgroup::"
+fi
 
 # Update checksums
 if [[ $INPUT_UPDPKGSUMS == true ]]; then
-    echo "Update checksums on PKGBUILD"
+    echo "::group::Updating checksums on PKGBUILD"
-    sudo -u builder updpkgsums
+    updpkgsums
     git diff PKGBUILD
+    echo "::endgroup::"
 fi
 
 # Generate .SRCINFO
 if [[ $INPUT_SRCINFO == true ]]; then
-    echo "Generate new .SRCINFO based on PKGBUILD"
+    echo "::group::Generating new .SRCINFO based on PKGBUILD"
-    sudo -u builder makepkg --printsrcinfo > .SRCINFO
+    makepkg --printsrcinfo >.SRCINFO
     git diff .SRCINFO
-fi
+    echo "::endgroup::"
-
-# Run makepkg
-if [[ -n "$INPUT_FLAGS" ]]; then
-    echo "Run makepkg with flags"
-    sudo -u builder makepkg $INPUT_FLAGS
 fi
 
 # Validate with namcap
 if [[ $INPUT_NAMCAP == true ]]; then
-    echo "Validate PKGBUILD with namcap"
+    echo "::group::Validating PKGBUILD with namcap"
     namcap -i PKGBUILD
+    echo "::endgroup::"
 fi
+
+# Install depends using paru from aur
+if [[ $INPUT_AUR == true ]]; then
+    echo "::group::Installing depends using paru"
+    source PKGBUILD
+    paru -Syu --removemake --needed --noconfirm "${depends[@]}" "${makedepends[@]}"
+    echo "::endgroup::"
+fi
+
+# Run makepkg
+if [[ -n $INPUT_FLAGS ]]; then
+    echo "::group::Running makepkg with flags"
+    makepkg $INPUT_FLAGS
+    echo "::endgroup::"
+fi
+
+echo "::group::Copying files from $HOME/gh-action to $WORKPATH"
+sudo cp -fv PKGBUILD "$WORKPATH"/PKGBUILD
+if [[ -e .SRCINFO ]]; then
+    sudo cp -fv .SRCINFO "$WORKPATH"/.SRCINFO
+fi
+echo "::endgroup::"