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

x/talks: 2 sets of deploy instructions #36825

Open
dmitshur opened this issue Jan 28, 2020 · 2 comments
Open

x/talks: 2 sets of deploy instructions #36825

dmitshur opened this issue Jan 28, 2020 · 2 comments
Assignees
Milestone

Comments

@dmitshur
Copy link
Member

@dmitshur dmitshur commented Jan 28, 2020

I've recently realized that, due to a series of unfortunate events spanning 2014-2020, we have accidentally ended up with 2 sets of deploy instructions for talks.golang.org:

  1. golang.org/x/build/cmd/tip README
  2. golang.org/x/talks README

We should pick one as canonical (likely the one in x/build/cmd/tip, because it has an auto-deploy feature), and update READMEs in both places to avoid any future confusion.

Making this issue quickly so I don't forget; will add more history/background later.

/cc @cagedmantis @toothrot @andybons

@dmitshur dmitshur added the NeedsFix label Jan 28, 2020
@dmitshur dmitshur added this to the Unreleased milestone Jan 28, 2020
@dmitshur dmitshur self-assigned this Jan 28, 2020
@rsc
Copy link
Contributor

@rsc rsc commented Mar 27, 2020

Definitely agree about not having two sets of instructions.

It's unfortunate that the x/build version requires Docker,
but if it happens automatically on push so that mere mortals
never have to run it, that's fine.

@dmitshur
Copy link
Member Author

@dmitshur dmitshur commented Mar 27, 2020

I investigated whether the deploy instructions in x/build/cmd/tip (which have the auto-deploy feature) can still be used today, but they have atrophied and cannot be used without making changes to get them functional again. I tried making small and safe changes to get them working, but it turned out larger changes are required to get them functional without also breaking tip.golang.org in the process. (I've described how they're broken in a separate issue #38120.)

The deploy instructions in x/talks are functional and have been used most recently. They lack the auto-deploy feature, unfortunately.

We could resolve this issue by continuing to use deploy instructions in golang.org/x/talks README for now, delete the non-functional instructions in x/build/cmd/tip (or at least mark them as "broken" and in need of fixing), and file a tracking issue about restoring the auto-deploy of x/talks content feature that used to exist. It can be resolved by making x/build/cmd/tip functional for serving talks.golang.org again, or another way.

Alternatively, we can fix x/cmd/tip deploy instructions (i.e., resolve #38120) and use them. I'll investigate that issue some more first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.