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

Workflow to sync changelog with Seqera docs #761

Merged
merged 1 commit into from
Nov 29, 2024

Conversation

vladsavelyev
Copy link
Contributor

@vladsavelyev vladsavelyev commented Nov 27, 2024

Automation to push a changelog entry into seqeralbas

That requires settings a PAT:

  • Log into the GitHub account you want to push PRs from (with admin rights for both repos)
  • Go to Settings > Developer Settings > Personal Access Tokens > Tokens (classic)
  • Click Generate new token
  • Select scope to push to seqeralabs/docs
  • Store the PAT as SEQERALABS_DOCS_PAT secret in wave repo

@vladsavelyev vladsavelyev requested a review from ewels November 27, 2024 20:45
@vladsavelyev vladsavelyev marked this pull request as draft November 28, 2024 10:03
@gavinelder
Copy link
Contributor

gavinelder commented Nov 28, 2024

Hi we should create a Github App for this purpose then save these as Org Secrets.

please see https://github.com/peter-evans/create-pull-request/blob/25b6871a4ebe4c3585f47c7a687ac6fd0ec0e32d/docs/concepts-guidelines.md

      - uses: actions/create-github-app-token@v1
        id: generate-token
        with:
          app-id: ${{ secrets.APP_ID }}
          private-key: ${{ secrets.APP_PRIVATE_KEY }}
          owner: owner
          repositories: fork-of-repo

      - uses: actions/checkout@v4

      # Make changes to pull request here

      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v7
        with:
          branch-token: ${{ steps.generate-token.outputs.token }}
          push-to-fork: owner/fork-of-repo
          maintainer-can-modify: false

UPDATE

Github App has been created and org secrets have been added

DOCS_BOT_APP_ID
DOCS_BOT_APP_PRIVATE_KEY

@vladsavelyev
Copy link
Contributor Author

Thanks @gavinelder, I updated the workflow to use the app. Could you please take a look to verify it looks good?

@vladsavelyev vladsavelyev marked this pull request as ready for review November 28, 2024 15:31
Use release metadata

Remove python script

Use app

Fix parameters

Add workflow_dispatch to test

Update .github/workflows/seqera_docs_changelog.yml

Co-authored-by: Gavin <[email protected]>

Test signed commit

Test signed commit
@vladsavelyev vladsavelyev force-pushed the sync-changelog-to-docs branch from fc4f024 to 02f090b Compare November 29, 2024 14:00
@vladsavelyev vladsavelyev merged commit c8bb7b0 into master Nov 29, 2024
4 checks passed
@vladsavelyev vladsavelyev deleted the sync-changelog-to-docs branch November 29, 2024 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants