Skip to content

Update Getting Started guides with release info#7681

Merged
erwinmombay merged 5 commits intoampproject:masterfrom
mrjoro:mrjoro-update-contributing
Feb 22, 2017
Merged

Update Getting Started guides with release info#7681
erwinmombay merged 5 commits intoampproject:masterfrom
mrjoro:mrjoro-update-contributing

Conversation

@mrjoro
Copy link
Copy Markdown
Member

@mrjoro mrjoro commented Feb 20, 2017

Added a section to the E2E and Quick Start Getting Started guides on how a changes gets to production and how the contributor can track where it is/test on Dev Channel.

cc @cramforce @bpaduch

@mrjoro mrjoro added this to the Docs Updates milestone Feb 20, 2017
@mrjoro mrjoro requested a review from erwinmombay February 20, 2017 18:59

# See your changes in production

* Barring any issues releases are cut Thursday, pushed to Dev Channel immediately, pushed to 1% on Monday and pushed to all of prod on Thursday.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

1% of AMP pages

…and pushed to all pages…

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.


If your change affected internal documentation, tests, the build process, etc. you can generally see your changes right after they're merged. If your change was to the code that runs on AMP pages across the web you'll have to wait for the change to be included in a release.

In general we cut a release of amphtml on Thursdays during working hours (Pacific time) and push it to the AMP Dev Channel that day. After verifying there are no issues, we start rolling that build out the following Monday and complete the push that Thursday.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe add: This is when all users of AMP will use your new code!

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.


In general we cut a release of amphtml on Thursdays during working hours (Pacific time) and push it to the AMP Dev Channel that day. After verifying there are no issues, we start rolling that build out the following Monday and complete the push that Thursday.

You can see whether your change made it into the Dev Channel or production build on the [amphtml Releases page](https://github.com/ampproject/amphtml/releases). The build marked `Draft` is the version on the Dev Channel and the build marked `Latest Release` is what is running in production. Your Pull Request will be listed in the first build that includes it; if you don't see your Pull Request listed it will likely be in the next build.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It should be marked "pre-release", not Draft. Draft releases cannot be seen by non-project members.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Got it; I was trying to reverse engineer the labels from where the Releases page was and what was currently on canary. I talked to @erwinmombay about it and realized they temporarily didn't have the right labels. :)


In general we cut a release of amphtml on Thursdays during working hours (Pacific time) and push it to the AMP Dev Channel that day. After verifying there are no issues, we start rolling that build out the following Monday and complete the push that Thursday.

You can see whether your change made it into the Dev Channel or production build on the [amphtml Releases page](https://github.com/ampproject/amphtml/releases). The build marked `Draft` is the version on the Dev Channel and the build marked `Latest Release` is what is running in production. Your Pull Request will be listed in the first build that includes it; if you don't see your Pull Request listed it will likely be in the next build.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

it should be "the latest build marked with prerelease is the version on dev channel"

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.

# See your changes in production

* Barring any issues releases are cut Thursday, pushed to Dev Channel immediately, pushed to 1% on Monday and pushed to all of prod on Thursday.
* The [amphtml Releases page](https://github.com/ampproject/amphtml/releases) will list your PR in the first build that contains it. `Draft` is the build on the Dev Channel, `Latest Release` is the build in production.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

update draft here too with "latest prerelease"

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.


# pull in the latest changes from the remote amphtml repository
git pull upstream master
git pull upstream master
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this assumes upstream is ampproject/amphtml right?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes; for the Getting Started guides we lead people through setting up the upstream alias to that. More advanced users can set it to whatever they want, but for the most part in these guides we try to stay away from providing too many options. :)

@mrjoro mrjoro force-pushed the mrjoro-update-contributing branch from 1583c43 to 531e88d Compare February 21, 2017 20:49
Copy link
Copy Markdown
Member Author

@mrjoro mrjoro left a comment

Choose a reason for hiding this comment

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

I also added README to reflect that we actually cut the next release on Wednesdays (since this can affect when people plan to get their work in by).


# pull in the latest changes from the remote amphtml repository
git pull upstream master
git pull upstream master
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes; for the Getting Started guides we lead people through setting up the upstream alias to that. More advanced users can set it to whatever they want, but for the most part in these guides we try to stay away from providing too many options. :)


If your change affected internal documentation, tests, the build process, etc. you can generally see your changes right after they're merged. If your change was to the code that runs on AMP pages across the web you'll have to wait for the change to be included in a release.

In general we cut a release of amphtml on Thursdays during working hours (Pacific time) and push it to the AMP Dev Channel that day. After verifying there are no issues, we start rolling that build out the following Monday and complete the push that Thursday.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.


In general we cut a release of amphtml on Thursdays during working hours (Pacific time) and push it to the AMP Dev Channel that day. After verifying there are no issues, we start rolling that build out the following Monday and complete the push that Thursday.

You can see whether your change made it into the Dev Channel or production build on the [amphtml Releases page](https://github.com/ampproject/amphtml/releases). The build marked `Draft` is the version on the Dev Channel and the build marked `Latest Release` is what is running in production. Your Pull Request will be listed in the first build that includes it; if you don't see your Pull Request listed it will likely be in the next build.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Got it; I was trying to reverse engineer the labels from where the Releases page was and what was currently on canary. I talked to @erwinmombay about it and realized they temporarily didn't have the right labels. :)


In general we cut a release of amphtml on Thursdays during working hours (Pacific time) and push it to the AMP Dev Channel that day. After verifying there are no issues, we start rolling that build out the following Monday and complete the push that Thursday.

You can see whether your change made it into the Dev Channel or production build on the [amphtml Releases page](https://github.com/ampproject/amphtml/releases). The build marked `Draft` is the version on the Dev Channel and the build marked `Latest Release` is what is running in production. Your Pull Request will be listed in the first build that includes it; if you don't see your Pull Request listed it will likely be in the next build.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.


# See your changes in production

* Barring any issues releases are cut Thursday, pushed to Dev Channel immediately, pushed to 1% on Monday and pushed to all of prod on Thursday.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.

# See your changes in production

* Barring any issues releases are cut Thursday, pushed to Dev Channel immediately, pushed to 1% on Monday and pushed to all of prod on Thursday.
* The [amphtml Releases page](https://github.com/ampproject/amphtml/releases) will list your PR in the first build that contains it. `Draft` is the build on the Dev Channel, `Latest Release` is the build in production.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.

@mrjoro
Copy link
Copy Markdown
Member Author

mrjoro commented Feb 22, 2017

I can't merge; @erwinmombay if it looks okay can you merge when you have a chance?

@erwinmombay erwinmombay merged commit 2212a10 into ampproject:master Feb 22, 2017
@erwinmombay
Copy link
Copy Markdown
Member

@mrjoro done

@mrjoro mrjoro deleted the mrjoro-update-contributing branch February 22, 2017 21:26
@mrjoro mrjoro mentioned this pull request Feb 27, 2017
mrjoro added a commit to mrjoro/amphtml that referenced this pull request Apr 28, 2017
* first draft

* added details inline; added quick start

* added a preface for doc/test/etc. changes

* minor fixes

* responding to review comments; adding README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants