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

Prepare for rename to setup-beam #20

Closed
starbelly opened this issue Mar 26, 2021 · 29 comments · Fixed by #21
Closed

Prepare for rename to setup-beam #20

starbelly opened this issue Mar 26, 2021 · 29 comments · Fixed by #21

Comments

@starbelly
Copy link
Member

After the setup erlang PR is merged (which I'm not linking to as I don't want it to close this issue) we need to do a PR to change instances of setup-elixir to setup-beam, this should be the limit of the scope. Once this is merged in, we can rename the repo.

@wojtekmach had previously tested if checking the name of repo and/or action effects usage of existing releases and it seems no, it should be fine. Though, we should surely double check this and do whatever we can do ensure this is the case prior.

If all this is good, then we can publish setup-beam@v1, once again operating under the assumption that setup-elixir@v1 will continue to work as is.

@paulo-ferraz-oliveira
Copy link
Collaborator

Do you know, if @v1 represents @v1.x or do we have to keep moving the tag up?

@starbelly
Copy link
Member Author

@paulo-ferraz-oliveira I would assume it does, but research required.

@paulo-ferraz-oliveira
Copy link
Collaborator

I'm asking especially since, at the moment, v1 and v1.6.0 are the same commit.

@starbelly
Copy link
Member Author

starbelly commented Mar 26, 2021

@paulo-ferraz-oliveira I think what we'll have to do is

  • fork this
  • publish as setup-elixir under the name space of the fork as v1 (v1.6)
  • rename it
  • publish as setup-beam under the name of the fork as v1 (v1.7)
  • observe
  • delete the fork and published actions

@paulo-ferraz-oliveira
Copy link
Collaborator

Yeah, sorry, it was a sidetracking question[1]. I agree with your plan, though.


[1] Still am unable to understand how @v1 is kept (@ericmj, is this tag manually moved?).

@starbelly
Copy link
Member Author

@paulo-ferraz-oliveira the way it works is you make a tag such as 1.6.0, you then reset v1 tag to the head of the new tag.

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

I think what we'll have to do is [...]

Why do we need to do anything other than renaming?

Still am unable to understand how @v1 is kept (@ericmj, is this tag manually moved?).

Yes.

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

Do we know if GitHub will keep the redirect forever from setup-elixir to setup-beam? If not, for how long will they redirect and what's the migration plan for users to the new action name?

@starbelly
Copy link
Member Author

Why do we need to do anything other than renaming?

Theoretically, that should be fine if you mean just rename the repo and publish a new 1.x version, but I just thought we might want to be doubly sure we don't mess up builds.

Do we know if GitHub will keep the redirect forever from setup-elixir to setup-beam? If not, for how long will they redirect and what's the migration plan for users to the new action name?

https://git.luolix.topmunity/t/how-long-does-github-forward-renamed-moved-repos/582

@ericmj TL;DR is indefinitely.

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

Theoretically, that should be fine if you mean just rename the repo and publish a new 1.x version, but I just thought we might want to be doubly sure we don't mess up builds.

What name are we going to use for the fork?

@wojtekmach
Copy link
Collaborator

wojtekmach commented Mar 27, 2021

Im not sure a fork is necessary, I'd rename the repo to setup-beam, test it with another project, and in an very unlikely case it doesn't work, rename it back. After a day or two, make an announcement that setup-beam is the new repo.

@starbelly
Copy link
Member Author

What name are we going to use for the fork?

@ericmj I would suggest something obscure, and not actually setup-elxir, especially for the publish

Im not sure a fork is necessary, I'd rename the repo to setup-beam, test it with another project, and in an very unlikely case it doesn't work, rename it back. After a day or two, make an announcement that setup-beam is the new repo.

Maybe, but I don't know, production is always the real test. I'd rather be extra sure with a small investment (i.e., fork, publish, rename, publish) than to break a bunch of builds and deal with an onslaught of issues and slack messages. But to your point, maybe I'm overly concerned here.. but yeah, being sure is no bad thing especially at a cheap cost.

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

If the rename doesn't work the fork won't help since it's using a different name and if it doesn't work we can just rename it back. Or what am I missing?

@starbelly
Copy link
Member Author

If the rename doesn't work the fork won't help since it's using a different name and if it doesn't work we can just rename it back. Or what am I missing?

Hmm what I'm suggesting is not doing the rename until after fork test is done, does that clarify?

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

Hmm what I'm suggesting is not doing the rename until after fork test is done, does that clarify?

What are we testing with the fork?

@starbelly
Copy link
Member Author

starbelly commented Mar 27, 2021

What are we testing with the fork?

After the a new repo is made with the contents of this repo and named something like starbelly/lorem-ipsum-dolor-sit-amet and AFTER the that is published as github action ( starbelly/lorem-ipsum-dolor-sit-amet@v1) we can rename the repo to say starbelly/ut-enim-ad-minim-veniam AND publish the action as starbelly/ut-enim-ad-minim-veniam@v1 that starbelly/lorem-ipsum-dolor-sit-amet continue to work, and possibly further that the new rebar3 functionality works as well.

All that said, if this is clearly documented some where in github that this should just work and we don't need to test it to be sure, then maybe not needed, but I saw no such documentation when I looked before and I myself just rather be sure. Like I said, the cost of doing so is just about nil, so I don't see why not.

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

After the a new repo is made with the contents of this repo and named something like starbelly/lorem-ipsum-dolor-sit-amet and AFTER the that is published as github action ( starbelly/lorem-ipsum-dolor-sit-amet@v1) we can rename the repo to say starbelly/ut-enim-ad-minim-veniam AND publish the action as starbelly/ut-enim-ad-minim-veniam@v1 that starbelly/lorem-ipsum-dolor-sit-amet continue to work, and possibly further that the new rebar3 functionality works as well.

I believe @wojtekmach already tested this and confirmed it to work. But nothing is blocking testing it again now so go ahead, we don't need to wait for anything to do a rename test on a separate repo.

@wojtekmach
Copy link
Collaborator

yeah I've already performed a test like that but as they say: if you want something done right, do it yourself :)

@starbelly
Copy link
Member Author

@wojtekmach I didn't think you tried publishing? That's my focus is on. Publish, use, rename, publish again, use. But maybe you did?

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

There isn't really a publish process for actions, we just use a git reference which normally is a tag. So if it works with one tag it should work with all, regardless of when it was created.

Also note that the rename is not blocked by the PR #9 being merged. In fact, we should wait a while with publishing v1.7 after merging so we can test the main branch on our own repos before publishing.

@starbelly
Copy link
Member Author

@ericmj That makes sense. I of course trust @wojtekmach too. I thought there was something "special" a "button" click :)

With that said, you ready to rename then?

@wojtekmach
Copy link
Collaborator

wojtekmach commented Mar 27, 2021

this is the test: wojtekmach/setup-elixir-bug@5158312. I've renamed wojtekmach/beamup2 to wojtekmach/beamup and that workflow continued to work after the rename.

@ericmj
Copy link
Collaborator

ericmj commented Mar 27, 2021

With that said, you ready to rename then?

We should have a PR ready with changes to the README and other places that references the name. Personally I would wait until the work week with doing the rename in case any support or quick fixes are needed, but that's up to you of course.

@starbelly
Copy link
Member Author

@ericmj hmm yeah, let me do that real quick.

@starbelly
Copy link
Member Author

@paulo-ferraz-oliveira You'll have a few merge conflicts to deal with, hate that the cookie crumbles that way, but @ericmj is right, this should happen first.

@starbelly
Copy link
Member Author

Personally I would wait until the work week with doing the rename in case any support or quick fixes are needed, but that's up to you of course.

Hmm you would wait until say Tuesday? Rationale being better to blow up in the week vs a big surprise on monday?

@starbelly
Copy link
Member Author

Personally I would wait until the work week with doing the rename in case any support or quick fixes are needed, but that's up to you of course.

Hmm you would wait until say Tuesday? Rationale being better to blow up in the week vs a big surprise on monday?

Ahh n/m your concern is about doing work on the weekend. Yeah, that makes sense.

@paulo-ferraz-oliveira
Copy link
Collaborator

Merge conflicts do not present an issue, at this moment. Your changes are very small in comparison to #9.

kianmeng added a commit to kianmeng/patch that referenced this issue Oct 23, 2022
kianmeng added a commit to kianmeng/lcov_ex that referenced this issue Oct 24, 2022
dariodf pushed a commit to dariodf/lcov_ex that referenced this issue Oct 24, 2022
kianmeng added a commit to kianmeng/exq that referenced this issue Oct 26, 2022
kianmeng added a commit to kianmeng/exq that referenced this issue Oct 26, 2022
xavier pushed a commit to xavier/xlsx_reader that referenced this issue Oct 30, 2022
kianmeng added a commit to kianmeng/farside that referenced this issue Oct 31, 2022
benbusby pushed a commit to benbusby/farside that referenced this issue Oct 31, 2022
kianmeng added a commit to kianmeng/dataloader that referenced this issue Nov 2, 2022
kianmeng added a commit to kianmeng/sparql_client that referenced this issue Nov 4, 2022
kianmeng added a commit to kianmeng/opq that referenced this issue Nov 7, 2022
kianmeng added a commit to kianmeng/ueberauth_google that referenced this issue Nov 14, 2022
Remove extra redirection. See erlef/setup-beam#20.
Also added GHA badge to readme.
kianmeng added a commit to kianmeng/remote_ip that referenced this issue Nov 17, 2022
ajvondrak pushed a commit to ajvondrak/remote_ip that referenced this issue Nov 17, 2022
doorgan added a commit to doorgan/sourceror that referenced this issue Feb 5, 2023
Remove the extra redirection. See erlef/setup-beam#20

Also, run additional linting (except dialyzer) using latest
Elixir/Erlang matrix.

Co-authored-by: dorgan <dorgandash@gmail.com>
ihumanable pushed a commit to ihumanable/patch that referenced this issue Oct 18, 2023
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 a pull request may close this issue.

4 participants