Skip to content

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

Merged
merged 21 commits into from
Dec 17, 2021
Merged

chore(cicd): Add release workflow #260

merged 21 commits into from
Dec 17, 2021

Conversation

flochaz
Copy link
Contributor

@flochaz flochaz commented Dec 6, 2021

Description of your changes

  1. Auto bump
  2. create Changelog
  3. publish to github release

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

  • ci: merge conflict (97796df)
  • ci: updated github actions commands (76ba8c7)
  • ci: updated NPM dependencies (audit) (3166c7b)
  • hosted-git-info bump in logger (fb2a365)
  • logger: jest set to next version as workaround for vulnerability (0f423bf)
  • logging: removed forgotten dummy folder (a10791f)
  • metrics: publish metrics even if handler throw (#249) (8ad0a6a)
  • upgrade of dependencies, npm-shrinkwrap for packages/logger (c120c64)
  • version bumb for commitlint/cli (0e1f6be)

Features

  • add metrics (#102) (cf22210)
  • Adding sample automation for PR (#121) (7bf63bb)
  • logger: add context decorator functionality (#13) (369e4d1)
  • logger: adding basic crude logger module, and support for log levels by passed param/env param (a3ff0ba)
  • logger: basic logger logic (#9) (5f867ea), closes #10
  • logger: lint error fixes (5272ac0)
  • logging: added basic lerna package for the logging module (14c679d)

Related issues, RFCs

#136

PR status

Is this ready for review?: NO
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

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

dreamorosi
dreamorosi previously approved these changes Dec 7, 2021
@dreamorosi dreamorosi added this to the beta-release milestone Dec 8, 2021
@dreamorosi dreamorosi added the automation This item relates to automation label Dec 8, 2021
@dreamorosi dreamorosi linked an issue Dec 10, 2021 that may be closed by this pull request
Copy link
Contributor

@saragerion saragerion left a 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?

@flochaz flochaz marked this pull request as draft December 13, 2021 11:26
@flochaz flochaz closed this Dec 15, 2021
@flochaz
Copy link
Contributor Author

flochaz commented Dec 15, 2021

Will open a new one with better way of handling

@flochaz flochaz reopened this Dec 15, 2021
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`

Copy link
Contributor

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?

Copy link
Contributor Author

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

@flochaz flochaz marked this pull request as ready for review December 16, 2021 14:37
@@ -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';
Copy link
Contributor

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",
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

saragerion
saragerion previously approved these changes Dec 17, 2021
Copy link
Contributor

@saragerion saragerion left a 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

saragerion
saragerion previously approved these changes Dec 17, 2021
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

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

LGTM

@flochaz flochaz merged commit ced810a into main Dec 17, 2021
@flochaz flochaz deleted the chore/releaseFlow branch December 17, 2021 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: release process
3 participants