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

Fix the OPA version bump workflow to work with the new README #1188

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

buidav
Copy link
Collaborator

@buidav buidav commented Jun 28, 2024

🗣 Description

  • This PR fixes the OPA version bump workflow by removing the code that assumes the old README format and tries to modify it.

Closes #1187

🧪 Testing

Example PR created from a scheduled workflow run: example OPA Update PR.
You can also fork ScubaGear, specifically this branch, to test this PR or your own fork.

📷 Screenshots (if appropriate)

Note that this GitHub action requires write permissions to PRs.
You can configure the permissions for this on the repo settings under Settings => Actions => General => Workflow permissions. Ensure the options below are selected.
checkedTheseBoxes

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@buidav buidav added the bug This issue or pull request addresses broken functionality label Jun 28, 2024
@buidav buidav added this to the Iceberg milestone Jun 28, 2024
@buidav buidav self-assigned this Jun 28, 2024
@buidav buidav linked an issue Jun 28, 2024 that may be closed by this pull request
Copy link
Collaborator

@james-garriss james-garriss left a comment

Choose a reason for hiding this comment

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

I agree with deleting this code. I recommend creating a new issue to put the OPA version in the constants file and then create one workflow that creates one README file for ALL software requirements, thus doing everything consistently. Please link it to this epic: #1136

@buidav
Copy link
Collaborator Author

buidav commented Jul 2, 2024

@nanda-katikaneni ready to merge

@nanda-katikaneni nanda-katikaneni merged commit e032b6c into main Jul 2, 2024
17 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 1187-fix-the-opa-version-bump-workflow branch July 2, 2024 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue or pull request addresses broken functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix the OPA version bump workflow to work with the new README
4 participants