-
Notifications
You must be signed in to change notification settings - Fork 153
chore(cicd): Add release workflow #260
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we add "safety nets" in at the beginning of this flow to make sure that only stable, safe code is published?
For example:
- Linting
- npm audit
- Unit tests
What do you think?
packages/logger/tests/unit/formatter/PowertoolLogFormatter.test.ts
Outdated
Show resolved
Hide resolved
Will open a new one with better way of handling |
…ertools-typescript into chore/releaseFlow
CONTRIBUTING.md
Outdated
You can build and start a local docs website by running these two commands. | ||
- `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/` | ||
- `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a section on all the steps that need to be done to successfully create a release?
For instance: was the changelog generated automatically? Anything manually we need to do?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no manual step needed. all done automatically. only constraint already mention in doc is follow semantic pull requests
packages/logger/README.md
Outdated
@@ -27,7 +27,7 @@ npm run example:ephemeral-attributes | |||
```typescript | |||
// Import the library | |||
import { Logger } from '../src'; | |||
// When going public, it will be something like: import { Logger } from '@aws-lambda-powertools/logger'; | |||
// When going public, it will be something like: import { Logger } from '@flochaz/logger'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops? I guess it should be @aws-lambda-powertools?
"main": "./lib/packages/metrics/src/index.js", | ||
"types": "./lib/packages/metrics/src/index.d.ts", | ||
"main": "./lib/index.js", | ||
"types": "./lib/index.d.ts", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Let's remember to add auditing, linting and tests check in the on-release workflow before making this repo public
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
805b1be
to
d2805e6
Compare
Description of your changes
How to verify this change
Ran in provate repo:
https://github.com/flochaz/aws-lambda-powertools-typescript/releases
Output:
0.1.0-beta.0 (2021-12-06)
Bug Fixes
Features
Related issues, RFCs
#136
PR status
Is this ready for review?: NO
Is it a breaking change?: NO
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.