Skip to content

contribute.md

Latest commit

 

History

History
38 lines (29 loc) · 2.04 KB

contribute.md

File metadata and controls

38 lines (29 loc) · 2.04 KB

Contribute to the 2Toad Actions project 🤝

Thank you for wanting to contribute to this project. With your help we can ensure these Actions remains a valuable contribution to the GitHub community.

Steps for success

  1. Issues:
    1. Always work off of an Issue. Please do not submit a Pull Request that is not associated with an Issue (create the Issue if necessary).
    2. If you are beginning work on an Issue, please leave a comment on the issue letting us know, and we'll assign the Issue to you. This way somebody else won't start working on the same Issue.
  2. Branches:
    1. Always branch off of main, which contains the latest version of actions
  3. Pull Request (PR):
    1. Make sure your PR is targeting the correct branch (see Step 2.i)
    2. At the top of your PR description write: "Fixes #n". Where n is the number of the Issue your PR is fixing (e.g., Fixes #33). This will tell GitHub to associate your PR with the Issue.

Testing

  1. Navigate to the Actions tab
  2. Select the "Test Actions" workflow
  3. Click "Run workflow"
  4. Select the branch containing the changes you want to test
  5. Click "Run workflow" to start the tests

This will run all test scenarios for both the install-trivy and run-trivy actions in parallel. Each test job is independent, so you can quickly identify which scenarios pass or fail.

Deployment

  1. Run the "Test Actions" workflow (see Testing) and ensure all tests pass before deploying
  2. Navigate to the Actions tab
  3. Select the "Deploy to Prod" workflow
  4. Click "Run workflow".
  5. Enter a version number using semantic versioning (e.g., 1.1.0).
  6. Click "Run workflow" to start the process.

This automated workflow will:

  • Create a new release with the specified version number
  • Generate release notes
  • Update the corresponding major version tag (e.g. v1 will point to v1.x)