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

chore: setup releases for v3 release candidates #52

Merged
merged 1 commit into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions .github/workflows/release-v2-main.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 33 additions & 2 deletions .github/workflows/release.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions .projen/tasks.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 27 additions & 2 deletions .projenrc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@ import { typescript } from 'projen';
const project = new typescript.TypeScriptProject({
name: 'cdk-assets',
projenrcTs: true,
publishDryRun: true,
defaultReleaseBranch: 'main',
majorVersion: 3,
prerelease: 'rc',
releaseBranches: {
'v2-main': {
majorVersion: 2,
npmDistTag: 'latest',
},
},
releaseToNpm: true,
npmDistTag: 'v3-latest',
autoApproveUpgrades: true,
autoApproveOptions: {
allowedUsernames: ['aws-cdk-automation'],
Expand Down Expand Up @@ -92,7 +94,13 @@ const project = new typescript.TypeScriptProject({
include: ['bin/**/*.ts'],
},
srcdir: 'lib',
gitignore: ['**/*.d.ts', '**/*.js', '**/.DS_Store'],
gitignore: ['**/*.d.ts', '**/*.js', '**/.DS_Store', 'npm-shrinkwrap.json'],
releaseWorkflowSetupSteps: [
{
name: 'Shrinkwrap',
run: 'npx projen shrinkwrap',
},
],
});

project.addPackageIgnore('*.ts');
Expand All @@ -105,4 +113,21 @@ project.eslint?.addRules({
],
});

project.addTask('shrinkwrap', {
steps: [
{
spawn: 'bump',
},
{
exec: 'npm shrinkwrap',
},
{
spawn: 'unbump',
},
{
exec: 'git checkout HEAD -- yarn.lock',
},
],
});

project.synth();
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# cdk-assets

<!--BEGIN STABILITY BANNER-->

---

> V3 of cdk-assets is still under active development and is subject to non-backward compatible changes while
> being released with the `rc` suffix.
>
> These changes are not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes
> will be announced in the release notes.

---

<!--END STABILITY BANNER-->

A tool for publishing CDK assets to AWS environments.

## Overview
Expand Down Expand Up @@ -39,7 +53,8 @@ asset, or the name of the local Docker image.

The `cdk-asset` tool can be used programmatically and via the CLI. Use
programmatic access if you need more control over authentication than the
default [`aws-sdk`](https://github.com/aws/aws-sdk-js) implementation allows.
default [AWS SDK for JavaScript v3](https://github.com/aws/aws-sdk-js-v3)
implementation allows.

Command-line use looks like this:

Expand Down
1 change: 1 addition & 0 deletions package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.