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

Rename unstable to main throughout codebase #1990

Merged
merged 3 commits into from
Jul 19, 2022
Merged

Conversation

shonfeder
Copy link
Contributor

@shonfeder shonfeder commented Jul 18, 2022

Closes #1012

NOTE: This PR is into the new branch named main, which will be made the default once this PR is is approved by the team.

Overview

The trunk of our development has been called unstable for a long time.
This is a holdover from before we adopted a trunk-based development
model, and from before we had CI/CD running for the trunk. Now, the
trunk is really not very unstable, and stability is given by versioned
releases, rather than by maintaining long-lived branches in parallel.

After this change, we should be able to reconfigure the default branch.

Notable changes

  • Renamed all mention of the unstable branch to main
  • Updated docs on installing from docker

Reviewing

With the exception of the update to the docker installation instructions and the changelog entry (both isolated in their own commits), the change effected here was purely mechanical, with the exception of the changelog entry. It couldn't hurt to have some sanity checks that I've not missed anything or altered anything I shouldn't have.


@shonfeder shonfeder marked this pull request as ready for review July 18, 2022 01:48
@codecov-commenter
Copy link

codecov-commenter commented Jul 18, 2022

Codecov Report

Merging #1990 (dbf13fd) into main (a86dcb7) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head dbf13fd differs from pull request most recent head a5a479a. Consider uploading reports for the commit a5a479a to get more accurate results

@@            Coverage Diff             @@
##             main    #1990      +/-   ##
==========================================
- Coverage   77.83%   77.82%   -0.02%     
==========================================
  Files         418      418              
  Lines       12813    12789      -24     
  Branches      584      566      -18     
==========================================
- Hits         9973     9953      -20     
+ Misses       2840     2836       -4     
Impacted Files Coverage Δ
...in/scala/at/forsyte/apalache/tla/lir/Feature.scala 0.00% <ø> (ø)
...n/scala/at/forsyte/apalache/tla/lir/TlaType1.scala 83.14% <ø> (-0.02%) ⬇️
...rsyte/apalache/tla/typecheck/TypeCheckerTool.scala 92.30% <0.00%> (-0.38%) ⬇️
.../forsyte/apalache/io/typecheck/parser/tokens.scala 92.85% <0.00%> (-0.25%) ⬇️
...syte/apalache/io/typecheck/parser/Type1Lexer.scala 95.55% <0.00%> (-0.10%) ⬇️
...ache/tla/typecheck/etc/TypeAliasSubstitution.scala
...apalache/tla/typecheck/etc/ConstSubstitution.scala 58.97% <0.00%> (ø)
...lache/io/typecheck/parser/DefaultType1Parser.scala 95.45% <0.00%> (+0.55%) ⬆️
...he/io/annotations/parser/CommentPreprocessor.scala 97.80% <0.00%> (+1.09%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a86dcb7...a5a479a. Read the comment docs.

@shonfeder shonfeder requested a review from thpani July 18, 2022 02:02
Comment on lines 6 to 7
- master
# TODO Remove once deploying unstable versions separately
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is cleanup from long ago :)

Copy link
Collaborator

@Kukovec Kukovec left a comment

Choose a reason for hiding this comment

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

Question, what happens to all the PRs in flight? Does GH know to change "XYZ wants to merge N commits into unstable from branch" or do they break?

Copy link
Collaborator

@konnov konnov left a comment

Choose a reason for hiding this comment

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

Good idea! I don't see any major issues with that, except that we would have to manually retarget active pull requests against trunk.

Copy link
Collaborator

@thpani thpani left a comment

Choose a reason for hiding this comment

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

I support moving away from unstable, but isn't trunk a very Subversion-y name?
Both Git and GitHub use main as the default branch name.

@thpani
Copy link
Collaborator

thpani commented Jul 18, 2022

We also already use main on the Cloud and TNT repos.

@shonfeder
Copy link
Contributor Author

shonfeder commented Jul 18, 2022

Question, what happens to all the PRs in flight? Does GH know to change "XYZ wants to merge N commits into unstable from branch" or do they break?

We’ll have to change the branch they are targeting the pending prs.

@shonfeder
Copy link
Contributor Author

We also already use main on the Cloud and TNT repos.

Ah good point. When the change away from master was happing, I configured my git config to use trunk, and I prefer it cause it fits with the branching metaphor, but forgot that it is less common. I’ll change this to main.

Shon Feder added 3 commits July 18, 2022 16:13
The advice was out of date with our current development practices, and
didn't make sense with the name switch of the development branch from
`unstable` to `main`.
@shonfeder shonfeder changed the title Rename unstable to trunk throughout codebase Rename unstable to main throughout codebase Jul 18, 2022
@shonfeder shonfeder changed the base branch from trunk to main July 18, 2022 20:14
@shonfeder shonfeder requested a review from thpani July 18, 2022 20:16
@shonfeder
Copy link
Contributor Author

Changed this to target main and to switch out the development branch name to main.

Copy link
Collaborator

@thpani thpani left a comment

Choose a reason for hiding this comment

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

👍

@shonfeder shonfeder merged commit 32d7032 into main Jul 19, 2022
@shonfeder shonfeder deleted the 1012/unstable-to-trunk branch July 19, 2022 16:07
@apalache-bot apalache-bot mentioned this pull request Jul 21, 2022
This was referenced Jul 25, 2022
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.

5 participants