Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add brassy build workflow on new tag #746

Merged
merged 12 commits into from
Aug 16, 2024
Merged

Conversation

biosafetylvl5
Copy link
Collaborator

@biosafetylvl5 biosafetylvl5 commented Aug 15, 2024

GitHub Actions Workflow: Generate Release Note with Brassy

Overview

This GitHub Actions workflow automates the generation and management of release notes. The workflow is triggered either manually via workflow_dispatch or automatically when a new tag is pushed.

Job: Generate Release

  1. Checkout Code

    • The code is checked out from the repository with all history and tags.
  2. Extract Branch Name

    • The current branch name is extracted using git, and it is stored in the GitHub Actions output.
  3. Extract Version

    • The latest version tag (excluding certain tags) is extracted from the repos new tag
  4. Install Brassy

  5. Run Brassy on File

    • A release note file is generated using brassy. A temporary header file is created for the release note, and the output is saved to a file named based on the extracted version.
  6. Commit New Release Note and Delete Old YAML Files

    • The new release note is committed to a new branch named after the current branch with a prefix update-release-note-.
    • Old YAML files in the release notes directory are deleted and committed.
  7. Push New Release Note to Branch

    • The new branch is pushed to the repository.
  8. Create Pull Request

@biosafetylvl5 biosafetylvl5 changed the title Add new workflow Add brassy build workflow on new tag Aug 15, 2024
@biosafetylvl5 biosafetylvl5 marked this pull request as ready for review August 15, 2024 20:48
@biosafetylvl5 biosafetylvl5 self-assigned this Aug 15, 2024
@biosafetylvl5 biosafetylvl5 linked an issue Aug 15, 2024 that may be closed by this pull request
1 task
@biosafetylvl5 biosafetylvl5 added the actions Updates and modifications to GitHub Actions label Aug 15, 2024
@biosafetylvl5
Copy link
Collaborator Author

Fixes #684

Copy link
Contributor

@mindyls mindyls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, excited to merge and tag/release and see what happens!

@mindyls mindyls requested a review from cpcamacho August 16, 2024 22:46
Copy link
Contributor

@cpcamacho cpcamacho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mindyls mindyls merged commit e66f2d4 into main Aug 16, 2024
12 checks passed
@mindyls mindyls deleted the 738-new-branch-brassy-on-tag branch August 16, 2024 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions Updates and modifications to GitHub Actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Commit brassy generated release note on pr merge
3 participants