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

docs: add release process #239

Merged
merged 5 commits into from
Mar 9, 2022
Merged

docs: add release process #239

merged 5 commits into from
Mar 9, 2022

Conversation

eunjae-lee
Copy link
Contributor

@eunjae-lee eunjae-lee commented Mar 8, 2022

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-369

Changes included:

  • Add "release process" page

[Preview →]

@eunjae-lee eunjae-lee changed the title Docs/contrib docs: add release process Mar 8, 2022
@eunjae-lee eunjae-lee requested review from a team, damcou and shortcuts and removed request for a team March 8, 2022 13:33
@netlify
Copy link

netlify bot commented Mar 8, 2022

✔️ Deploy Preview for api-clients-automation canceled.

🔨 Explore the source changes: 9916bab

🔍 Inspect the deploy log: https://app.netlify.com/sites/api-clients-automation/deploys/6228cab6fb59f700085e474a

Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

Good too! Few comments, only one blocking is the submodules

website/docs/introduction.md Show resolved Hide resolved

# Release process

The most of the release process is automated.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to state it

website/docs/releaseProcess.md Outdated Show resolved Hide resolved
website/docs/releaseProcess.md Outdated Show resolved Hide resolved
website/docs/releaseProcess.md Outdated Show resolved Hide resolved

## Part 3

The [GitHub action release](https://github.com/algolia/api-clients-automation/blob/main/.github/workflows/process-release.yml) is triggered. It generates clients and push changes to the submodules. All the submodules will have new commits on their base branch (`next`).
Copy link
Member

Choose a reason for hiding this comment

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

We don't use submodules anymore

@eunjae-lee eunjae-lee requested a review from shortcuts March 9, 2022 10:40
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

🙆🏼

@eunjae-lee eunjae-lee enabled auto-merge (squash) March 9, 2022 15:41
@eunjae-lee eunjae-lee merged commit e8e25ab into main Mar 9, 2022
@eunjae-lee eunjae-lee deleted the docs/contrib branch March 9, 2022 15:44
shortcuts added a commit that referenced this pull request Apr 22, 2022
* docs: add release process

* Apply suggestions from code review

Co-authored-by: Clément Vannicatte <[email protected]>

* docs: apply feedback

* docs: remove submodule mention

Co-authored-by: Clément Vannicatte <[email protected]>
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.

2 participants