From b263cb1af7757851df3077ebe4c86154d69c17f0 Mon Sep 17 00:00:00 2001 From: Tom Date: Mon, 1 May 2023 12:23:21 +0100 Subject: [PATCH] docs: Actions documented (#81) --- .github/workflows/deploy-docker-image.yml | 3 ++- .github/workflows/greetings.yml | 3 ++- .github/workflows/lint-pr-title.yml | 3 ++- README.md | 17 +++++++++++++++++ 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy-docker-image.yml b/.github/workflows/deploy-docker-image.yml index 18a6bca4b..5eab420b0 100644 --- a/.github/workflows/deploy-docker-image.yml +++ b/.github/workflows/deploy-docker-image.yml @@ -14,7 +14,8 @@ jobs: packages: write steps: # Checks out the main branch of the repository to the runner - - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 + - name: checkout + uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 with: fetch-depth: "0" diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index 5cdf85b1f..86218a2a1 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -11,7 +11,8 @@ jobs: pull-requests: write issues: write steps: - - uses: actions/first-interaction@1d8459ca65b335265f1285568221e229d45a995e # v1.1.1 + - name: First Interaction + uses: actions/first-interaction@1d8459ca65b335265f1285568221e229d45a995e # v1.1.1 with: issue-message: "Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid." pr-message: "Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/GhostWriters/docker-packt-cli/blob/main/.github/PULL_REQUEST_TEMPLATE.md)!" diff --git a/.github/workflows/lint-pr-title.yml b/.github/workflows/lint-pr-title.yml index 3cf25df0e..d64499388 100644 --- a/.github/workflows/lint-pr-title.yml +++ b/.github/workflows/lint-pr-title.yml @@ -14,6 +14,7 @@ jobs: name: Validate PR title runs-on: ubuntu-latest steps: - - uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0 + - name: Check Title + uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index 96a3d3baf..6b6e795cd 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,23 @@ You can mount two volumes to persist the Packt credentials and store the downloa Once you run the container, it will automatically download a free eBook each day from Packt publishing and store the files in the `/home/user/packt/books` directory on your host system. +## GitHub Actions Used + +- [actions/checkout](https://github.com/actions/checkout) - Action for checking out code from a repository. +- [actions/first-interaction](https://github.com/actions/first-interaction) - Action to identify a user's first contribution to a repository. +- [actions/upload-artifact](https://github.com/actions/upload-artifact) - Action for uploading artifacts for later use in the workflow. +- [amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request) - Action for enforcing conventional commit messages and semantic versioning. +- [anothrNick/github-tag-action](https://github.com/anothrNick/github-tag-action) - Action for automatically creating a new tag and release based on version numbers. +- [docker/build-push-action](https://github.com/docker/build-push-action) - Action for building and pushing Docker images. +- [docker/login-action](https://github.com/docker/login-action) - Action for logging in to a Docker registry. +- [docker/metadata-action](https://github.com/docker/metadata-action) - Action for adding Docker metadata to a GitHub repository. +- [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action) - Action for setting up Buildx on your Github Actions runner. +- [docker/setup-qemu-action](https://github.com/docker/setup-qemu-action) - Action for setting up QEMU for cross-builds. +- [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) - Action for creating pull requests programmatically. +- [softprops/action-gh-release](https://github.com/softprops/action-gh-release) - Action for creating GitHub releases. +- [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) - Action for automatically committing changes to a repository. +- [oxsecurity/megalinter](https://github.com/oxsecurity/megalinter) - Action for linting multiple languages at once. + ## Contributing If you have any feedback or run into issues with the container, please open an [issue](https://github.com/GhostWriters/docker-packt-cli/issues/new) on the GitHub repository. If you would like to contribute to this project, you can submit a [pull request](https://github.com/GhostWriters/docker-packt-cli/pulls).