atlass 1.14.0 → 2.1.0

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.
package/README.md CHANGED
@@ -72,9 +72,10 @@ Writes `PROJ-123.md` or `123456-title-slug.md` to the current directory, with
72
72
  attachments in a sibling `<name>.assets/` folder. Pass `--out` with a directory
73
73
  or file path to write elsewhere. Existing files are overwritten.
74
74
 
75
- Each file has YAML frontmatter, an H1, the body as Markdown, a `## Comments`
76
- section, and an `## Attachments` section. Inline images link to the local copy
77
- when they can be matched to an attachment.
75
+ Each file has YAML frontmatter, an H1, the body as Markdown, then a
76
+ `<!-- atlass:generated -->` line followed by the `## Comments` and
77
+ `## Attachments` sections. Inline images link to the local copy when they can be
78
+ matched to an attachment.
78
79
 
79
80
  ## Update
80
81
 
@@ -88,8 +89,13 @@ atlass confluence update file.md --title # also push the H1 as the title
88
89
  atlass confluence update file.md -m "fix typo"
89
90
  ```
90
91
 
91
- Both accept `--dry-run` to preview and `--force` to skip the checks below. The
92
- body sent is everything between the H1 and `## Comments`.
92
+ Both accept `--dry-run` to preview and `--force` to skip the checks below. A
93
+ Confluence dry run also prints a diff of the body against the server. A dry run
94
+ exits 1 when the real update would refuse, or would need to ask and cannot
95
+ because there is no terminal or `--no-input` is set.
96
+
97
+ The body sent is everything between the H1 and the `<!-- atlass:generated -->`
98
+ line, or the first `## Comments` or `## Attachments` in older copies.
93
99
 
94
100
  - The update aborts if the issue or page changed on the server since the copy.
95
101
  - Panels, macros, expands, and layouts were flattened on copy and cannot be
@@ -97,6 +103,9 @@ body sent is everything between the H1 and `## Comments`.
97
103
  overwriting.
98
104
  - Confluence uploads local images referenced in the body as attachments. Jira
99
105
  update does not support image changes yet.
106
+ - After an update, the new `updated` (and for Confluence, `version`, and `title`
107
+ with `--title`) is written back to the frontmatter, so the file can be pushed
108
+ again without a fresh copy.
100
109
 
101
110
  ## Create
102
111
 
@@ -123,6 +132,18 @@ assignees take `me`, an account id, or a name matching one assignable user.
123
132
  `--dry-run` prints the resolved payload. `--json` prints the created key, id,
124
133
  and URL. `jira fields` shows what each field expects.
125
134
 
135
+ ```bash
136
+ atlass confluence create notes.md --space DEV
137
+ atlass confluence create notes.md --space DEV --parent 123456 --star
138
+ ```
139
+
140
+ `confluence create` publishes a Markdown file as a new page. The title is the
141
+ H1, or `title` in the frontmatter. The space comes from `--space` or `space` in
142
+ the frontmatter, and the page goes under the space homepage unless `--parent`
143
+ names another page. Local images are uploaded as attachments. The file then gets
144
+ the same frontmatter as a copy, so `update` works on it straight away.
145
+ `--dry-run` previews and exits 1 if the create would be refused.
146
+
126
147
  ## List
127
148
 
128
149
  ```bash
@@ -138,7 +159,9 @@ In Progress first, then To Do, and the most recently updated at the top of each
138
159
  group. Done issues are left out; `--all` adds those updated in the last 30 days.
139
160
 
140
161
  `confluence list` shows the pages you starred as `ID SPACE Age Title`, most
141
- recently updated first. `--limit` works as for search.
162
+ recently updated first. `--limit` works as for search. Star or unstar a page
163
+ with `atlass confluence star <page>` or `unstar <page>`, where `<page>` is an
164
+ id, a URL, or a copied `.md` file.
142
165
 
143
166
  For both, `--json` and `--copy` work as for search.
144
167
 
@@ -146,17 +169,29 @@ For both, `--json` and `--copy` work as for search.
146
169
 
147
170
  ```bash
148
171
  atlass jira search "safari login"
149
- atlass jira search --project PROJ --assignee me --status "In Progress"
150
- atlass jira search --jql "project = PROJ AND labels = regression"
151
- atlass confluence search "onboarding" --space DOCS
152
- atlass confluence search --cql "label = runbook ORDER BY created DESC"
172
+ atlass jira search --project PROJ --assignee me --open
173
+ atlass jira search --status "In Progress" --status "In Review" --updated 2w
174
+ atlass confluence search "onboarding" --space DOCS --label runbook
175
+ ```
176
+
177
+ Jira filters on `--project`, `--assignee`, `--reporter`, `--status`, `--type`,
178
+ `--label`, `--updated` and `--open`; Confluence on `--space`, `--label`,
179
+ `--updated` and `--starred`. Repeating a flag matches any of its values;
180
+ different flags must all match. `--assignee` and `--reporter` take `me`, an
181
+ account id, or a name to look up. `--updated` takes `7d`, `2w`, `3m` or
182
+ `YYYY-MM-DD`. Results sort by most recently updated and use the same columns
183
+ as `jira list` and `confluence list`.
184
+
185
+ For anything the filters do not cover, write the query yourself:
186
+
187
+ ```bash
188
+ atlass jira jql "project = PROJ AND labels = regression ORDER BY created DESC"
189
+ atlass confluence cql "label = runbook AND creator = currentUser()"
153
190
  ```
154
191
 
155
- Filters combine with AND and sort by most recently updated. Rows use the same
156
- columns as `jira list` and `confluence list`. `--jql` and `--cql` replace the
157
- friendly filters. `--limit` defaults to 25, max 100. `--json` prints machine
158
- output. Add `--copy` to pick results interactively and copy each one, with
159
- `--out` as the target directory.
192
+ `--limit` defaults to 25, max 100. `--json` prints machine output. Add `--copy`
193
+ to pick results interactively and copy each one, with `--out` as the target
194
+ directory. All four work on both search commands.
160
195
 
161
196
  Discovery aids for the filters:
162
197
 
@@ -1,5 +1,5 @@
1
1
  #!/usr/bin/env node
2
- import { n as buildStandalone, r as fail } from "./build-CFyTL_x2.mjs";
2
+ import { n as buildStandalone, r as fail } from "./build-_4VuIcqF.mjs";
3
3
  //#region src/bitbucket.ts
4
4
  buildStandalone("bitbucket").parseAsync().catch(fail);
5
5
  //#endregion