@catladder/cli 1.162.0 → 1.163.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/CONTRIBUTING.md +3 -86
  2. package/README.md +6 -29
  3. package/dist/bundles/catenv/index.js +1 -1
  4. package/dist/bundles/cli/index.js +1 -1
  5. package/dist/pipeline/src/build/types.d.ts +6 -0
  6. package/dist/pipeline/src/build/types.js.map +1 -1
  7. package/dist/pipeline/src/pipeline/generatePipelineFiles.d.ts +38 -0
  8. package/dist/pipeline/src/pipeline/generatePipelineFiles.js +41 -19
  9. package/dist/pipeline/src/pipeline/generatePipelineFiles.js.map +1 -1
  10. package/dist/tsconfig.tsbuildinfo +1 -1
  11. package/package.json +4 -3
package/CONTRIBUTING.md CHANGED
@@ -1,88 +1,5 @@
1
- ### Commit message guidelines
1
+ # Contribution
2
2
 
3
- #### Atomic commits
3
+ [See contribution guide][docs-contribute].
4
4
 
5
- If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means that a commit should:
6
-
7
- - Contain exactly one self-contained functional change
8
- - Not depend on changes in one of your later commits
9
- - Not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc…)
10
-
11
- A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
12
-
13
- #### Commit message format
14
-
15
- Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
16
-
17
- ```commit
18
- <type>(<scope>): <subject>
19
- <BLANK LINE>
20
- <body>
21
- <BLANK LINE>
22
- <footer>
23
- ```
24
-
25
- The **header** is mandatory and the **scope** of the header is optional.
26
-
27
- The **footer** can contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages).
28
-
29
- #### Revert
30
-
31
- If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
32
- In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
33
-
34
- #### Type
35
-
36
- The type must be one of the following:
37
-
38
- | Type | Description |
39
- | ------------ | ----------------------------------------------------------------------------------------------------------- |
40
- | **build** | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
41
- | **ci** | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
42
- | **docs** | Documentation only changes |
43
- | **feat** | A new feature |
44
- | **fix** | A bug fix |
45
- | **perf** | A code change that improves performance |
46
- | **refactor** | A code change that neither fixes a bug nor adds a feature |
47
- | **style** | Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc) |
48
- | **test** | Adding missing tests or correcting existing tests |
49
-
50
- #### Subject
51
-
52
- The subject contains a succinct description of the change:
53
-
54
- - use the imperative, present tense: "change" not "changed" nor "changes"
55
- - don't capitalize the first letter
56
- - no dot (.) at the end
57
-
58
- #### Body
59
-
60
- Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
61
- The body should include the motivation for the change and contrast this with previous behaviour.
62
-
63
- #### Footer
64
-
65
- The footer should contain any information about **Breaking Changes** and is also the place to reference GitLab issues that this commit **Closes**.
66
-
67
- **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
68
- The rest of the commit message is then used for this.
69
-
70
- #### Examples
71
-
72
- ```commit
73
- `fix(pencil): stop graphite breaking when too much pressure applied`
74
- ```
75
-
76
- ```commit
77
- `feat(pencil): add 'graphiteWidth' option`
78
-
79
- Fix #42
80
- ```
81
-
82
- ```commit
83
- perf(pencil): remove graphiteWidth option`
84
-
85
- BREAKING CHANGE: The graphiteWidth option has been removed.
86
-
87
- The default graphite width of 10mm is always used for performance reasons.
88
- ```
5
+ [docs-contribute]: https://catladder.git.panter.biz/catladder/docs/contribute "Contribution guide"
package/README.md CHANGED
@@ -1,41 +1,18 @@
1
1
  # catladder 🐱 🔧
2
2
 
3
- Panter cli tool for Kubernetes.
3
+ [Panter](https://panter.ch) cli tool for cloud CI/CD and DevOps.
4
4
 
5
- ## Install
6
-
7
- ```sh
8
- # yarn users
9
- yarn global add @catladder/cli
10
- # npm users
11
- npm install -g @catladder/cli
12
- ```
13
-
14
- > **Note**: If you have [@catladder/pipeline](https://www.npmjs.com/package/@catladder/pipeline) installed, upgrade it to >=4.0.0 before installing [@catladder/cli](https://www.npmjs.com/package/@catladder/cli).
5
+ **It just works™**
15
6
 
16
7
  ## Getting started
17
8
 
18
- You'll need:
19
-
20
- - Google Cloud SDK ([see installation instructions](https://cloud.google.com/sdk/docs/install))
21
- - Kubectl ([see installation instructions](https://kubernetes.io/docs/tasks/tools/))
22
- - Cloud SQL Auth proxy ([see installation instructions](https://cloud.google.com/sql/docs/postgres/sql-proxy#install))
23
-
24
- Afterwards, you need to connect to your cluster, e.g. `gcloud container clusters get-credentials clustername --zone google-zone --project google-project-id`
25
- In most cases, you'll find the details on the Google Cloud [cluster overview ](https://console.cloud.google.com/kubernetes/list?project=skynet-164509)
9
+ [See the documentation][docs-getting-started].
26
10
 
27
- It just works™
28
-
29
- ## Preferences
30
-
31
- Catladder stores some preferences in `~/.catladder/preferences.yml` in case you want to change settings.
11
+ [docs-getting-started]: https://catladder.git.panter.biz/catladder/docs/getting_started "Getting started"
32
12
 
33
13
  ## Contribution
34
14
 
35
- Check the documentation [here](https://git.panter.ch/catladder/catladder/-/tree/main/cli/CONTRIBUTING.md).
36
-
37
- ### Adding packages in cli
15
+ [See contribution guide][docs-contribute].
38
16
 
39
- if you add npm libs in cli, make sure to add them as dev-dependencies.
17
+ [docs-contribute]: https://catladder.git.panter.biz/catladder/docs/contribute "Contribution guide"
40
18
 
41
- the reason is that we bundle all dependencies in the cli package, so that if you add that to your project, it won't install all @catladder/cli's dependencies.