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

docs(homepage): auto-update Layer ARN on every release #1610

Merged
merged 12 commits into from
Oct 18, 2022

Conversation

rubenfonseca
Copy link
Contributor

@rubenfonseca rubenfonseca commented Oct 17, 2022

Issue number: #1549

Summary

This PR automates the publishing of the layer version in our documetation for every release.
This will reduce maintance overhead, and make the publishing of the new layer version faster.

Changes

Please provide a summary of what's being changed

User experience

Please share what the user experience looks like before and after this change

After this change, the new layer version will be update don the documentation automatically, as soon as the Layer is created and published.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.


View rendered docs/index.md

@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation github-actions Pull requests that update Github_actions code internal Maintenance changes labels Oct 17, 2022
@pull-request-size pull-request-size bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Oct 17, 2022
@github-actions github-actions bot added the feature New feature or functionality label Oct 17, 2022
@rubenfonseca rubenfonseca marked this pull request as ready for review October 17, 2022 09:57
@rubenfonseca rubenfonseca requested a review from a team as a code owner October 17, 2022 09:57
@rubenfonseca rubenfonseca requested review from heitorlessa and a team and removed request for a team October 17, 2022 09:57
Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

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

two minor issues (git add missing docs, and docs alias) - and one major to add comments on shell script as not everyone is a seasoned bash (and regex) wizardry like you ;D

.github/workflows/reusable_publish_v2_layer_arn.yml Outdated Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
.github/workflows/reusable_publish_v2_layer_arn.yml Outdated Show resolved Hide resolved
@rubenfonseca
Copy link
Contributor Author

Note: update the rest of the SAM sample code on docs/index.md

@rubenfonseca
Copy link
Contributor Author

Note: remove "Can't find our Lambda Layer for your preferred AWS region?" because we are now publishing in all regions.

@heitorlessa
Copy link
Contributor

Docs looks excellent. Perhaps let's just increase md-grid (where the content is) to 90vw to give a bit more room, otherwise the layer per region table will look too tight

Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

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

looks great! added last suggestions on var names

layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
layer/scripts/update_layer_arn.sh Outdated Show resolved Hide resolved
@heitorlessa
Copy link
Contributor

Consider it approved after these last changes to ease maintenance.

Co-authored-by: Heitor Lessa <lessa@amazon.nl>
@heitorlessa heitorlessa changed the title feat(docs): update docs when creating a new Layer ARN docs(homepage): auto-update Layer ARN on every release Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or functionality github-actions Pull requests that update Github_actions code internal Maintenance changes size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
2 participants