Skip to content

Add Beachball to Repo #2 #2113

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

Merged
merged 23 commits into from
Aug 8, 2020
Merged

Add Beachball to Repo #2 #2113

merged 23 commits into from
Aug 8, 2020

Conversation

pkanher617
Copy link
Contributor

@pkanher617 pkanher617 commented Aug 6, 2020

How it works:

  1. Developer creates a PR that affects X packages.
  2. The "Beachball Check" workflow will check whether the developer has committed changefiles, and will fail and prevent merging if it does not detect them.
  3. The developer run "npm run beachball:change" at the root of the repo locally on their PR branch and describes the changes to each affected package. Beachball will generate changefiles and commit them to the branch. The developer should push these changefiles and merge them when the PR is approved.
  4. Changefiles are collected on dev. When all the files are ready to be published, a PR to master is created. On merge, the beachball publish command is run, which reviews the changefiles for the highest order release (i.e. major, minor, patch), then bumps the package versions and their dependency versions accordingly, and finally performs the publish.

@github-actions github-actions bot added the samples Related to the samples apps for the library. label Aug 6, 2020
@coveralls
Copy link

coveralls commented Aug 6, 2020

Coverage Status

Coverage remained the same at 81.794% when pulling 64d2105 on beachball-config into 5c8d98e on dev.

@github-actions github-actions bot added the msal-browser Related to msal-browser package label Aug 6, 2020
Copy link
Collaborator

@tnorling tnorling left a comment

Choose a reason for hiding this comment

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

One question but approved! Excited for this!

@@ -0,0 +1,3 @@
{
"shouldPublish": false
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a way to ignore the samples folder completely so we don't have to add this to every sample?

Copy link
Contributor Author

@pkanher617 pkanher617 Aug 6, 2020

Choose a reason for hiding this comment

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

I wanted to use the path config but beachball is currently overwriting the path config parameter with cwd so until they fix their config we need to do this.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Got it. Makes sense

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I opened a ticket here: microsoft/beachball#377

Copy link
Contributor

@sangonzal sangonzal left a comment

Choose a reason for hiding this comment

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

Would be nice to have a description of what the release process looks like after this is merged in, as it's hard to deduce from the config files.

We should also be careful going forward to always include this

{
    "shouldPublish": false
}

into any samples.

@github-actions github-actions bot added the [email protected] Related to [email protected] (implicit flow) label Aug 7, 2020
@github-actions github-actions bot added msal-angular Related to @azure/msal-angular package msal-common Related to msal-common package labels Aug 7, 2020
@github-actions github-actions bot added the msal-node Related to msal-node package label Aug 7, 2020
@pkanher617
Copy link
Contributor Author

Example of what is added to the changelog for a minor version change:

## 1.4.0

Fri, 07 Aug 2020 21:42:47 GMT

### Minor changes

- updating files for automated release steps ([email protected])

Copy link
Contributor

@sangonzal sangonzal left a comment

Choose a reason for hiding this comment

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

Looks good.

@pkanher617 pkanher617 merged commit 84a5f5a into dev Aug 8, 2020
@pkanher617 pkanher617 deleted the beachball-config branch October 2, 2020 18:07
@zhangxAmtrak zhangxAmtrak mentioned this pull request Nov 4, 2020
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[email protected] Related to [email protected] (implicit flow) msal-angular Related to @azure/msal-angular package msal-browser Related to msal-browser package msal-common Related to msal-common package msal-node Related to msal-node package samples Related to the samples apps for the library.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants