Skip to content

Commit

Permalink
chore: move to rc pre-releases (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrgrain authored Oct 24, 2021
1 parent 1608bb7 commit 552ec90
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .projen/tasks.json

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

2 changes: 1 addition & 1 deletion .projenrc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ const project = new AwsCdkConstructLibrary({
npmDistTag: 'next',
defaultReleaseBranch: 'next',
majorVersion: 2,
prerelease: 'alpha',
prerelease: 'rc',
releaseTrigger: release.ReleaseTrigger.manual(),
catalog: {
twitter: '@mrgrain',
Expand Down
48 changes: 24 additions & 24 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ public readonly buildOptions: BuildOptions;

Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.

`buildOptions.outdir: string` \
`buildOptions.outdir: string`
The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
*Cannot be used together with `outfile`*.
- `buildOptions.outfile: string` \
Relative path to a file inside the CDK asset output directory. \
- `buildOptions.outfile: string`
Relative path to a file inside the CDK asset output directory.
For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
*Cannot be used with multiple entryPoints or together with `outdir`.*
- `buildOptions.absWorkingDir: string` \
- `buildOptions.absWorkingDir: string`
Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).

Expand Down Expand Up @@ -613,15 +613,15 @@ public readonly buildOptions: BuildOptions;

Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.

`buildOptions.outdir: string` \
`buildOptions.outdir: string`
The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
*Cannot be used together with `outfile`*.
- `buildOptions.outfile: string` \
Relative path to a file inside the CDK asset output directory. \
- `buildOptions.outfile: string`
Relative path to a file inside the CDK asset output directory.
For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
*Cannot be used with multiple entryPoints or together with `outdir`.*
- `buildOptions.absWorkingDir: string` \
- `buildOptions.absWorkingDir: string`
Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).

Expand Down Expand Up @@ -685,15 +685,15 @@ public readonly buildOptions: BuildOptions;

Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.

`buildOptions.outdir: string` \
`buildOptions.outdir: string`
The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
*Cannot be used together with `outfile`*.
- `buildOptions.outfile: string` \
Relative path to a file inside the CDK asset output directory. \
- `buildOptions.outfile: string`
Relative path to a file inside the CDK asset output directory.
For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
*Cannot be used with multiple entryPoints or together with `outdir`.*
- `buildOptions.absWorkingDir: string` \
- `buildOptions.absWorkingDir: string`
Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).

Expand Down Expand Up @@ -751,15 +751,15 @@ public readonly buildOptions: BuildOptions;

Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.

`buildOptions.outdir: string` \
`buildOptions.outdir: string`
The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
*Cannot be used together with `outfile`*.
- `buildOptions.outfile: string` \
Relative path to a file inside the CDK asset output directory. \
- `buildOptions.outfile: string`
Relative path to a file inside the CDK asset output directory.
For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
*Cannot be used with multiple entryPoints or together with `outdir`.*
- `buildOptions.absWorkingDir: string` \
- `buildOptions.absWorkingDir: string`
Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).

Expand Down Expand Up @@ -1107,15 +1107,15 @@ public readonly buildOptions: BuildOptions;

Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.

`buildOptions.outdir: string` \
`buildOptions.outdir: string`
The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
*Cannot be used together with `outfile`*.
- `buildOptions.outfile: string` \
Relative path to a file inside the CDK asset output directory. \
- `buildOptions.outfile: string`
Relative path to a file inside the CDK asset output directory.
For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
*Cannot be used with multiple entryPoints or together with `outdir`.*
- `buildOptions.absWorkingDir: string` \
- `buildOptions.absWorkingDir: string`
Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).

Expand Down Expand Up @@ -1173,15 +1173,15 @@ public readonly buildOptions: BuildOptions;

Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.

`buildOptions.outdir: string` \
`buildOptions.outdir: string`
The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
*Cannot be used together with `outfile`*.
- `buildOptions.outfile: string` \
Relative path to a file inside the CDK asset output directory. \
- `buildOptions.outfile: string`
Relative path to a file inside the CDK asset output directory.
For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
*Cannot be used with multiple entryPoints or together with `outdir`.*
- `buildOptions.absWorkingDir: string` \
- `buildOptions.absWorkingDir: string`
Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).

Expand Down
8 changes: 4 additions & 4 deletions src/bundler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ export interface BundlerProps {
/**
* Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
*
* - `buildOptions.outdir: string` \
* - `buildOptions.outdir: string`
* The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
* For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
* *Cannot be used together with `outfile`*.
* - `buildOptions.outfile: string` \
* Relative path to a file inside the CDK asset output directory. \
* - `buildOptions.outfile: string`
* Relative path to a file inside the CDK asset output directory.
* For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
* *Cannot be used with multiple entryPoints or together with `outdir`.*
* - `buildOptions.absWorkingDir: string` \
* - `buildOptions.absWorkingDir: string`
* Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
* If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).
*
Expand Down

0 comments on commit 552ec90

Please sign in to comment.