From 86ba87b9d1366d8d4b5ce7bd169172d3fac8b93d Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Fri, 22 Sep 2023 16:40:16 +0200 Subject: [PATCH] Rename Compliance.yml to Copier.yml --- .../workflows/{Compliance.yml.jinja => Copier.jinja} | 10 +++++----- CHANGELOG.md | 6 +++--- README.md | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) rename .github/workflows/{Compliance.yml.jinja => Copier.jinja} (87%) diff --git a/.github/workflows/Compliance.yml.jinja b/.github/workflows/Copier.jinja similarity index 87% rename from .github/workflows/Compliance.yml.jinja rename to .github/workflows/Copier.jinja index 8ff68a50..dc34bd5b 100644 --- a/.github/workflows/Compliance.yml.jinja +++ b/.github/workflows/Copier.jinja @@ -1,4 +1,4 @@ -{% raw %}name: Template Compliance +{% raw %}name: Copier Update on: schedule: @@ -6,12 +6,12 @@ on: workflow_dispatch: jobs: - Compliance: + Copier: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: - token: ${{ secrets.COMPLIANCE_PAT }} + token: ${{ secrets.COPIER_PAT }} - uses: julia-actions/setup-julia@v1 with: version: "1" @@ -25,7 +25,7 @@ jobs: run: | pip install copier copier update -A -o rej - echo -e "Automated changed by Compliance.yml workflow\n" > /tmp/body.md + echo -e "Automated changed by Copier.yml workflow\n" > /tmp/body.md echo -e 'Rejected changes (if any):\n```diff\n' >> /tmp/body.md find . -name "*.rej" | xargs cat >> /tmp/body.md find . -name "*.rej" | xargs rm -f @@ -39,7 +39,7 @@ jobs: id: cpr uses: peter-evans/create-pull-request@v5 with: - token: ${{ secrets.COMPLIANCE_PAT }} + token: ${{ secrets.COPIER_PAT }} commit-message: ":robot: COPIERTemplate.jl update" title: "[AUTO] COPIERTemplate.jl update" body-path: /tmp/body.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 285a545a..beaad2d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,19 +25,19 @@ and this project adheres to [Semantic Versioning]. ### Fixed -- Properly fix compliance when there are conflicts +- Properly fix copier update when there are conflicts ## [0.1.4] - 2023-09-22 ### Fixed -- Fix compliance when there are conflicts +- Fix copier update when there are conflicts ## [0.1.3] - 2023-09-21 ### Added -- Run pre-commit in the compliance workflow to commit the formatters change as well +- Run pre-commit in the Copier workflow to commit the formatters change as well ### Changed diff --git a/README.md b/README.md index bcc5b34b..743df193 100644 --- a/README.md +++ b/README.md @@ -74,13 +74,13 @@ I have done that in the past, but now I want even less manual intervention. Follow the instruction in the terminal. -1. Create a Personal Access Token to be used by the Compliance workflow. +1. Create a Personal Access Token to be used by the Copier workflow. 1. Go to . 2. Create a token with "Content", "Pull-request", and "Workflows" permissions. 3. Copy the Token. 4. Go to your YOUR_PACKAGE_URL/settings/secrets/actions. - 5. Create a "New repository secret" named `COMPLIANCE_PAT`. + 5. Create a "New repository secret" named `COPIER_PAT`. 1. Before releasing, enable Zenodo integration at . @@ -135,7 +135,7 @@ Also slightly related, is the `.editorconfig` file, which tells your editor, if The select a few workflows, with a strong possibility of expanding in the future: - CompatHelper.yml: Should be well known by now. It checks that your Project.toml compat entries are up-to-date. -- Compliance.yml: This will periodically check the template for updates. If there are updates, this action creates a pull request updating your repo. +- Copier.yml: This will periodically check the template for updates. If there are updates, this action creates a pull request updating your repo. - Docs.yml: Build the docs. Only runs when relevant files change. - Lint.yml: Run the linter and formatter through the command `pre-commit run -a`. - TagBot.yml: Create GitHub releases automatically after your new release is merged on the Registry.