Skip to content

docs: add support for docs versioning (#1239) #1293

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Jul 28, 2023
Merged

docs: add support for docs versioning (#1239) #1293

merged 7 commits into from
Jul 28, 2023

Conversation

@kozub
Copy link
Contributor

@kozub kozub commented Jul 18, 2023

Issue #, if available:
#1239

Description of changes:

Add support for versioning:

  • use Mike in mkdocs configuratin
  • update github workflows (base on PowerTools Python and TypeScript config)

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

@codecov-commenter
Copy link

codecov-commenter commented Jul 18, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (661100c) 79.35% compared to head (5ffe381) 79.35%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files 
@@            Coverage Diff            @@
##               main    #1293   +/-   ##
=========================================
  Coverage     79.35%   79.35%           
  Complexity      641      641           
=========================================
  Files            73       73           
  Lines          2446     2446           
  Branches        253      253           
=========================================
  Hits           1941     1941           
  Misses          425      425           
  Partials         80       80

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

scottgerring
scottgerring reviewed Jul 19, 2023
View reviewed changes
scottgerring
scottgerring approved these changes Jul 26, 2023
View reviewed changes
Copy link
Contributor

@scottgerring scottgerring left a comment

Choose a reason for hiding this comment

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

LGTM. I think we should uncomment the S3 publish and try trigger it manually for an old release from main, then patch if needed. Keen to get @sthulb 's feedback as well as he has worked a lot on this

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jul 28, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@scottgerring scottgerring merged commit 3dc8405 into main Jul 28, 2023
@scottgerring scottgerring deleted the 1239/version-docs branch July 28, 2023 06:56
@jeromevdl
Copy link
Contributor

jeromevdl commented Jul 28, 2023 •
edited
Loading

@scottgerring @kozub the doc is still not versioned (https://docs.powertools.aws.dev/lambda/java/). How do we do that? Would be great to have it before we push the batch and large messages (as there will be deprecations, new modules...)

@sthulb
Copy link
Contributor

sthulb commented Jul 28, 2023

https://github.com/aws-powertools/powertools-lambda-java/actions/runs/5689418997

this PR contains errors

scottgerring added a commit that referenced this pull request Jul 28, 2023
@scottgerring
Revert "docs: add support for docs versioning (#1239) (#1293)"
9e62424 
This reverts commit 3dc8405.
scottgerring added a commit that referenced this pull request Jul 28, 2023
@scottgerring
fix: Rollback doc changes (#1323)
bddd99a 
* Revert "docs: versioning - fix typo (#1322)"

This reverts commit a0c7d38.

* Revert "docs: add support for docs versioning (#1239) (#1293)"

This reverts commit 3dc8405.
jeromevdl pushed a commit that referenced this pull request Jul 29, 2023
@scottgerring @jeromevdl
fix: Rollback doc changes (#1323)
9aa9a58 
* Revert "docs: versioning - fix typo (#1322)"

This reverts commit a0c7d38.

* Revert "docs: add support for docs versioning (#1239) (#1293)"

This reverts commit 3dc8405.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@scottgerring scottgerring scottgerring approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

size/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@kozub @codecov-commenter @jeromevdl @sthulb @scottgerring