From 7b022b073be6aceb7a60a22690cf9819e3df1507 Mon Sep 17 00:00:00 2001 From: R-Palazzo Date: Wed, 8 Jan 2025 15:33:07 +0100 Subject: [PATCH 1/5] create prepare_release.yml --- .github/workflows/prepare_release.yml | 57 +++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 .github/workflows/prepare_release.yml diff --git a/.github/workflows/prepare_release.yml b/.github/workflows/prepare_release.yml new file mode 100644 index 00000000..79613150 --- /dev/null +++ b/.github/workflows/prepare_release.yml @@ -0,0 +1,57 @@ +name: Release Prep + +on: + workflow_dispatch: + inputs: + branch: + description: 'Branch to merge release notes and code analysis into.' + required: true + default: 'main' + version: + description: + 'Version to use for the release. Must be in format: X.Y.Z.' + date: + description: + 'Date of the release. Must be in format YYYY-MM-DD.' + +jobs: + preparerelease: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python 3.10 + uses: actions/setup-python@v5 + with: + python-version: '3.10' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install requests==2.31.0 + python -m pip install bandit==1.7.7 + python -m pip install .[test] + + - name: Generate release notes + env: + GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }} + run: > + python scripts/release_notes_generator.py + -v ${{ inputs.version }} + -d ${{ inputs.date }} + + - name: Save static code analysis + run: bandit -r . -x ./tests,./scripts,./build -f txt -o static_code_analysis.txt --exit-zero + + - name: Create pull request + id: cpr + uses: peter-evans/create-pull-request@v4 + with: + token: ${{ secrets.GH_ACCESS_TOKEN }} + commit-message: Prepare release for v${{ inputs.version }} + author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" + committer: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" + title: v${{ inputs.version }} Release Preparation + body: "This is an auto-generated PR to prepare the release." + branch: prepared-release + branch-suffix: short-commit-hash + base: ${{ inputs.branch }} \ No newline at end of file From df806fbc8cb44885bb01718c90698cb05dccbc2d Mon Sep 17 00:00:00 2001 From: R-Palazzo Date: Wed, 8 Jan 2025 15:34:00 +0100 Subject: [PATCH 2/5] delete release_notes and static_code_analysis workflow --- .github/workflows/release_notes.yml | 52 ---------------------- .github/workflows/static_code_analysis.yml | 35 --------------- 2 files changed, 87 deletions(-) delete mode 100644 .github/workflows/release_notes.yml delete mode 100644 .github/workflows/static_code_analysis.yml diff --git a/.github/workflows/release_notes.yml b/.github/workflows/release_notes.yml deleted file mode 100644 index 501c4892..00000000 --- a/.github/workflows/release_notes.yml +++ /dev/null @@ -1,52 +0,0 @@ -name: Release Notes Generator - -on: - workflow_dispatch: - inputs: - branch: - description: 'Branch to merge release notes into.' - required: true - default: 'main' - version: - description: - 'Version to use for the release. Must be in format: X.Y.Z.' - date: - description: - 'Date of the release. Must be in format YYYY-MM-DD.' - -jobs: - releasenotesgeneration: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Set up Python 3.10 - uses: actions/setup-python@v5 - with: - python-version: '3.10' - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - python -m pip install requests==2.31.0 - - - name: Generate release notes - env: - GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }} - run: > - python -m scripts.release_notes_generator - -v ${{ inputs.version }} - -d ${{ inputs.date }} - - - name: Create pull request - id: cpr - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.GH_ACCESS_TOKEN }} - commit-message: Release notes for v${{ inputs.version }} - author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" - committer: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" - title: v${{ inputs.version }} Release Notes - body: "This is an auto-generated PR to update the release notes." - branch: release-notes - branch-suffix: short-commit-hash - base: ${{ inputs.branch }} diff --git a/.github/workflows/static_code_analysis.yml b/.github/workflows/static_code_analysis.yml deleted file mode 100644 index e5dfac04..00000000 --- a/.github/workflows/static_code_analysis.yml +++ /dev/null @@ -1,35 +0,0 @@ -name: Static Code Analysis - -on: - release: - types: [published] - workflow_dispatch: - -jobs: - code-analysis: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Set up Python 3.10 - uses: actions/setup-python@v5 - with: - python-version: '3.10' - - name: Install dependencies - run: | - python -m pip install --upgrade pip - python -m pip install bandit==1.7.7 - - name: Save code analysis - run: bandit -r . -x ./tests,./scripts -f txt -o static_code_analysis.txt --exit-zero - - name: Create pull request - id: cpr - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.GH_ACCESS_TOKEN }} - commit-message: Update static code analysis - author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" - committer: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>" - title: Latest Code Analysis - body: "This is an auto-generated PR with the **latest** code analysis results." - branch: static-code-analysis - branch-suffix: short-commit-hash - base: main From 0b620d7d845bea14daa480455a0695d34725f72c Mon Sep 17 00:00:00 2001 From: R-Palazzo Date: Wed, 8 Jan 2025 15:44:27 +0100 Subject: [PATCH 3/5] add blank line --- .github/workflows/prepare_release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/prepare_release.yml b/.github/workflows/prepare_release.yml index 79613150..a755683b 100644 --- a/.github/workflows/prepare_release.yml +++ b/.github/workflows/prepare_release.yml @@ -54,4 +54,4 @@ jobs: body: "This is an auto-generated PR to prepare the release." branch: prepared-release branch-suffix: short-commit-hash - base: ${{ inputs.branch }} \ No newline at end of file + base: ${{ inputs.branch }} From f8fa954127f872ce5f912882715d00d829702ca0 Mon Sep 17 00:00:00 2001 From: R-Palazzo Date: Thu, 9 Jan 2025 12:14:21 +0100 Subject: [PATCH 4/5] make the workflow appear in the tab --- .github/workflows/prepare_release.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/prepare_release.yml b/.github/workflows/prepare_release.yml index a755683b..5e12c46a 100644 --- a/.github/workflows/prepare_release.yml +++ b/.github/workflows/prepare_release.yml @@ -1,6 +1,9 @@ name: Release Prep on: + push: + branches: + - issue-915-release-note workflow_dispatch: inputs: branch: From 5f915a7220b620f17517f21973e5e94a7d14a00c Mon Sep 17 00:00:00 2001 From: R-Palazzo Date: Thu, 9 Jan 2025 12:14:59 +0100 Subject: [PATCH 5/5] remove trigger on pushes --- .github/workflows/prepare_release.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/prepare_release.yml b/.github/workflows/prepare_release.yml index 5e12c46a..a755683b 100644 --- a/.github/workflows/prepare_release.yml +++ b/.github/workflows/prepare_release.yml @@ -1,9 +1,6 @@ name: Release Prep on: - push: - branches: - - issue-915-release-note workflow_dispatch: inputs: branch: