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

[release automation] Add documentation building job to build_release_candidate.yml workflow #28136

Merged
merged 37 commits into from
Aug 25, 2023

Conversation

lostluck
Copy link
Contributor

@lostluck lostluck commented Aug 24, 2023

Create Docs PR with a Github Action for building release artifacts.

Based largely on the existing build_release_candidate.sh script, but with the following changes:

  • No longer quarantine each doc generator into it's own clone.
  • Leverage available steps for checking out code instead.
  • Use gh instead of hub.
  • Adds a use of the release managers' github token.
  • Converts parts to steps to clarify logging and failures.
    • Uses local envs, and working directory to clarify where we're working.

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@github-actions
Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@lostluck lostluck changed the title Test version of release candidate docs action. title Aug 24, 2023
@lostluck lostluck changed the title title [release automation] Add documentation building job to build_release_candidate.yml workflow Aug 24, 2023
@lostluck
Copy link
Contributor Author

R: @damccorm

Largely final action, other than the fix to ttypescript (Main in #28133)

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control

@lostluck
Copy link
Contributor Author

I'll update the release guide to go along with this.

Copy link
Contributor

@damccorm damccorm left a comment

Choose a reason for hiding this comment

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

Thanks!

.github/workflows/build_release_candidate.yml Outdated Show resolved Hide resolved
@lostluck
Copy link
Contributor Author

I've removed the additional install line, so typescript will be busted until #28133 is submitted and cherry picked.

@lostluck lostluck merged commit 98da850 into master Aug 25, 2023
@lostluck lostluck deleted the lostluck-thats-how-you-doc-rc branch August 25, 2023 19:44
lostluck added a commit to lostluck/beam that referenced this pull request Aug 30, 2023
…candidate.yml workflow (apache#28136)

* Test version of release candidate docs action.

* Fix variable substitutions.

* Fix typo.

* Attempt to work around typescript 1

* workaround maven config issue

* Move where we pull commit.

* Use gh instead

* set name and email for git.

* push branche

* Only typescript for fast iter.

* just with gh

* set base branch for pr

* more token

* set upstream

* simplify create

* No f.

* typo

* Add base

* tidy 1

* update string

* no fail

* Better body message

* Quotes.

* tiny tidy

* Add working directory.

* change no-fail approach

* Partial refactor

* clean up single use env vars

* fix typo

* working dir typo

* cleanup

* add full action execution.

* Update release guide.

* Move beam site token to above the job conditionals.

* Update token text.

* Remove npm dep.

* Adjust headings.

---------

Co-authored-by: lostluck <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants