diff --git a/.github/workflows/release-publish.yml b/.github/workflows/release-publish.yml index 5054e76c79..32063d2fe5 100644 --- a/.github/workflows/release-publish.yml +++ b/.github/workflows/release-publish.yml @@ -51,14 +51,20 @@ jobs: - name: Dry-run publishing run: pnpm publish -r --no-git-checks --dry-run - - name: Publish to NPM + - name: Pre publishing changes run: | echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc node .github/scripts/trim-fe-packageJson.js node .github/scripts/ensure-provenance-fields.mjs + cp README.md packages/cli/README.md sed -i "s/default: 'dev'/default: 'stable'/g" packages/cli/dist/config/schema.js - pnpm publish -r --publish-branch ${{github.event.pull_request.base.ref}} --access public --tag rc --no-git-checks - npm dist-tag rm n8n rc + + - name: Publish to NPM + run: pnpm publish -r --publish-branch ${{github.event.pull_request.base.ref}} --access public --tag rc --no-git-checks + + - name: Cleanup rc tag + run: npm dist-tag rm n8n rc + continue-on-error: true - id: set-release run: echo "release=${{ env.RELEASE }}" >> $GITHUB_OUTPUT diff --git a/jest.config.js b/jest.config.js index 3caac38ef9..d1d8f95e12 100644 --- a/jest.config.js +++ b/jest.config.js @@ -12,6 +12,8 @@ const tsJestOptions = { const { baseUrl, paths } = require('get-tsconfig').getTsconfig().config?.compilerOptions; +const isCoverageEnabled = process.env.COVERAGE_ENABLED === 'true'; + /** @type {import('jest').Config} */ const config = { verbose: true, @@ -32,8 +34,8 @@ const config = { return acc; }, {}), setupFilesAfterEnv: ['jest-expect-message'], - collectCoverage: process.env.COVERAGE_ENABLED === 'true', - coverageReporters: ['text-summary'], + collectCoverage: isCoverageEnabled, + coverageReporters: ['text-summary', 'lcov', 'html-spa'], collectCoverageFrom: ['src/**/*.ts'], }; diff --git a/packages/cli/README.md b/packages/cli/README.md deleted file mode 100644 index 0235c694da..0000000000 --- a/packages/cli/README.md +++ /dev/null @@ -1,150 +0,0 @@ -![n8n.io - Workflow Automation](https://user-images.githubusercontent.com/65276001/173571060-9f2f6d7b-bac0-43b6-bdb2-001da9694058.png) - -# n8n - Workflow Automation Tool - -n8n is a free and open [fair-code](https://faircode.io) distributed node-based Workflow Automation Tool. You can self-host n8n, easily extend it, and even use it with internal tools. - -n8n.io - Screenshot - -## Contents - - - -- [Demo](#demo) -- [Getting Started](#getting-started) - - [Use npx](#use-npx) - - [Run with Docker](#run-with-docker) - - [Install with npm](#install-with-npm) - - [Sign-up on n8n.cloud](#sign-up-on-n8n.cloud) -- [Available integrations](#available-integrations) -- [Documentation](#documentation) -- [Create Custom Nodes](#create-custom-nodes) -- [Contributing](#contributing) -- [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it) -- [Support](#support) -- [Jobs](#jobs) -- [Upgrading](#upgrading) -- [License](#license) - - -## Demo - -📺 Here's a [:tv: short video (< 4 min)](https://www.youtube.com/watch?v=RpjQTGKm-ok) that goes over key concepts of creating workflows in n8n. - -## Getting Started - -There are a couple of ways to get started with n8n. - -### Use npx - -To spin up n8n using npx, you can run: - -```bash -npx n8n -``` - -It will download everything that is needed to start n8n. - -You can then access n8n by opening: -[http://localhost:5678](http://localhost:5678) - -**Note:** The minimum required version for Node.js is v18. Make sure to update Node.js to v18 or above. - -### Run with Docker - -To play around with n8n, you can also start it using Docker: - -```bash -docker run -it --rm \ - --name n8n \ - -p 5678:5678 \ - docker.n8n.io/n8nio/n8n -``` - -Be aware that all the data will be lost once the Docker container gets removed. To persist the data mount the `~/.n8n` folder: - -```bash -docker run -it --rm \ - --name n8n \ - -p 5678:5678 \ - -v ~/.n8n:/home/node/.n8n \ - docker.n8n.io/n8nio/n8n -``` - -Refer to the [documentation](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md) for more information on the Docker setup. - -### Install with npm - -To install n8n globally using npm: - -```bash -npm install n8n -g -``` - -After the installation, start n8n running the following command: - -```bash -n8n -# or -n8n start -``` - -### Sign-up on n8n.cloud - -Sign-up for an [n8n.cloud](https://www.n8n.cloud/) account. - -While n8n.cloud and n8n are the same in terms of features, n8n.cloud provides certain conveniences such as: - -- Not having to set up and maintain your n8n instance -- Managed OAuth for authentication -- Easily upgrading to the newer n8n versions - -## Available integrations - -n8n has 280+ different nodes that allow you to connect various services and build your automation workflows. You can find the list of all the integrations at [https://n8n.io/integrations](https://n8n.io/integrations) - -## Documentation - -To learn more about n8n, refer to the official documentation here: [https://docs.n8n.io](https://docs.n8n.io) - -You can find additional information and example workflows on the [n8n.io](https://n8n.io) website. - -## Create Custom Nodes - -You can create custom nodes for n8n. Follow the instructions mentioned in the documentation to create your node: [Creating nodes](https://docs.n8n.io/integrations/creating-nodes/build/) - -## Contributing - -🐛 Did you find a bug? - -✨ Do you want to contribute a feature? - -The [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) will help you set up your development environment. - -You can find more information on how you can contribute to the project on our documentation: [How can I contribute?](https://docs.n8n.io/reference/contributing.html) - -## What does n8n mean, and how do you pronounce it? - -**Short answer:** n8n is an abbreviation for "nodemation", and it is pronounced as n-eight-n. - -**Long answer:** In n8n, you build your automation ("-mation") workflows by connecting different nodes in the Editor UI. The project is also built using Node.js. As a consequence, the project was named nodemation. - -However, the name was long, and it wouldn't be a good idea to use such a long name in the CLI. Hence, nodemation got abbreviated as "n8n" (there are eight characters between the first and the last n!). - -## Support - -If you run into issues or have any questions reach out to us via our community forum: [https://community.n8n.io](https://community.n8n.io). - -## Jobs - -If you are interested in working at n8n and building the project, check out the [job openings](https://apply.workable.com/n8n/). - -## Upgrading - -Before you upgrade to the latest version, make sure to check the changelogs: [Changelog](https://docs.n8n.io/reference/changelog.html) - -You can also find breaking changes here: [Breaking Changes](./BREAKING-CHANGES.md) - -## License - -You can find the license information [here](https://github.com/n8n-io/n8n/blob/master/README.md#license)