carta-frontend 5.0.0-dev → 5.0.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/CHANGELOG.md +9 -3
- package/build/asset-manifest.json +5 -5
- package/build/index.html +1 -1
- package/build/static/css/main.4f08d1bb.css +1 -0
- package/build/static/js/index.f5ea988d.worker.js +2 -0
- package/build/static/js/{main.3eb48ba0.js → main.8626e15a.js} +2 -2
- package/build/static/js/zfp_wrapper.wasm +0 -0
- package/docs_website/docs/code-snippet-tutorial/image-fitting.mdx +7 -5
- package/docs_website/docs/code-snippet-tutorial/quick-start.mdx +1 -1
- package/docs_website/docs/code-snippet-tutorial/regions.mdx +1 -1
- package/docs_website/docs/contributing/github-workflow.md +4 -4
- package/docs_website/docs/contributing/release-guidelines.md +9 -9
- package/docs_website/versioned_docs/version-4.1.0/code-snippet-tutorial/quick-start.mdx +1 -1
- package/docs_website/versioned_docs/version-4.1.0/code-snippet-tutorial/regions.mdx +1 -1
- package/docs_website/versioned_docs/version-4.1.0/contributing/github-workflow.md +4 -4
- package/docs_website/versioned_docs/version-4.1.0/contributing/release-guidelines.md +9 -9
- package/docs_website/versioned_docs/version-5.0.0-beta.1c/code-snippet-tutorial/quick-start.mdx +1 -1
- package/docs_website/versioned_docs/version-5.0.0-beta.1c/code-snippet-tutorial/regions.mdx +1 -1
- package/docs_website/versioned_docs/version-5.0.0-beta.1c/contributing/github-workflow.md +4 -4
- package/docs_website/versioned_docs/version-5.0.0-beta.1c/contributing/release-guidelines.md +9 -9
- package/package.json +5 -4
- package/schemas/.github/workflows/AddToCartaVisProject.yml +23 -0
- package/schemas/.prettierrc.json +18 -0
- package/schemas/CMakeLists.txt +15 -0
- package/schemas/README.md +1 -0
- package/schemas/_config.yml +7 -0
- package/schemas/controller_config_schema_1.json +343 -0
- package/schemas/controller_config_schema_2.json +685 -0
- package/schemas/layout_schema_2.json +440 -0
- package/schemas/preference_backend_schema_1.json +81 -0
- package/schemas/preference_backend_schema_2.json +118 -0
- package/schemas/preference_schema_1.json +410 -0
- package/schemas/preferences_schema_2.json +434 -0
- package/schemas/schemacompiler.c +200 -0
- package/schemas/snippet_schema_1.json +45 -0
- package/schemas/workspace_schema_1.json +573 -0
- package/build/static/css/main.f89d4550.css +0 -1
- package/build/static/js/index.73b34931.worker.js +0 -2
- /package/build/static/js/{index.73b34931.worker.js.LICENSE.txt → index.f5ea988d.worker.js.LICENSE.txt} +0 -0
- /package/build/static/js/{main.3eb48ba0.js.LICENSE.txt → main.8626e15a.js.LICENSE.txt} +0 -0
|
Binary file
|
|
@@ -15,12 +15,15 @@ const file = await app.openFile("[filename]");
|
|
|
15
15
|
// Display the fitting widget
|
|
16
16
|
app.dialogStore.showDialog("fitting-dialog");
|
|
17
17
|
|
|
18
|
-
//
|
|
19
|
-
app.imageFittingStore.clearComponents();
|
|
20
|
-
|
|
21
|
-
// Set initial values
|
|
18
|
+
// Set the number of Gaussian components
|
|
22
19
|
app.imageFittingStore.setComponents(2);
|
|
23
20
|
|
|
21
|
+
// Option 1: Fit the image with auto generated initial values
|
|
22
|
+
app.imageFittingStore.fitImage();
|
|
23
|
+
|
|
24
|
+
// Option 2: Fit the image without auto generated initial values
|
|
25
|
+
app.imageFittingStore.setIsAutoInitVal(false);
|
|
26
|
+
|
|
24
27
|
const component1 = app.imageFittingStore.components[0];
|
|
25
28
|
component1.setCenterX(128);
|
|
26
29
|
component1.setCenterY(129);
|
|
@@ -37,6 +40,5 @@ component2.setFwhmX(4);
|
|
|
37
40
|
component2.setFwhmY(9);
|
|
38
41
|
component2.setPa(40);
|
|
39
42
|
|
|
40
|
-
// Fit the image
|
|
41
43
|
app.imageFittingStore.fitImage();
|
|
42
44
|
```
|
|
@@ -79,4 +79,4 @@ app.closeFile(file1, false); // No user confirmation
|
|
|
79
79
|
app.closeOtherFiles(file2);
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
For all functions and objects
|
|
82
|
+
For all functions and objects available in the <ApiLink path="/.-stores/class/AppStore">`app`</ApiLink> object, please refer to the <ApiLink path="/.-stores/class/AppStore">API documentation</ApiLink>.
|
|
@@ -14,7 +14,7 @@ const file = await app.openFile("my_image.fits");
|
|
|
14
14
|
|
|
15
15
|
## Creating regions
|
|
16
16
|
|
|
17
|
-
Regions on a specific image
|
|
17
|
+
Regions on a specific image are accessible via <ApiLink path="/.-stores/class/RegionSetStore">`RegionSetStore`</ApiLink> under each image. Each region is represented by a <ApiLink path="/.-stores/class/RegionStore">`RegionStore`</ApiLink> object.
|
|
18
18
|
|
|
19
19
|
```javascript
|
|
20
20
|
console.log(file.regionSet.regions); // View all regions
|
|
@@ -10,7 +10,7 @@ The workflow for contributing to the codebase.
|
|
|
10
10
|
|
|
11
11
|
When creating new issues, please refer to [this page](https://github.com/CARTAvis/carta-frontend/labels) for the available labels that can be added.
|
|
12
12
|
|
|
13
|
-
If the issue is related to bug fixing, please use the [bug report template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/ISSUE_TEMPLATE/bug_report.md). Please make sure to fill in the template with all the necessary information, including the description, reproduction steps, and platform information. Providing reproduction steps is particularly helpful for
|
|
13
|
+
If the issue is related to bug fixing, please use the [bug report template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/ISSUE_TEMPLATE/bug_report.md). Please make sure to fill in the template with all the necessary information, including the description, reproduction steps, and platform information. Providing reproduction steps is particularly helpful for resolving issues. Additionally, including testing images can be helpful for reproducing the issue.
|
|
14
14
|
|
|
15
15
|
## Contributing to the codebase
|
|
16
16
|
|
|
@@ -53,7 +53,7 @@ git push
|
|
|
53
53
|
|
|
54
54
|
#### Pull request template
|
|
55
55
|
|
|
56
|
-
When making a pull request from
|
|
56
|
+
When making a pull request from your branch, please use the [pull request template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/pull_request_template.md).
|
|
57
57
|
|
|
58
58
|
In the description section, please provide details about your changes, including linked issues and companion pull requests (if there are), what is implemented or fixed, and how to test it.
|
|
59
59
|
|
|
@@ -117,7 +117,7 @@ If the pull request requires changes in the carta-protobuf submodule and is read
|
|
|
117
117
|
2. Check out the frontend branch:
|
|
118
118
|
|
|
119
119
|
```
|
|
120
|
-
git checkout
|
|
120
|
+
git checkout [the frontend branch]
|
|
121
121
|
```
|
|
122
122
|
|
|
123
123
|
3. Check out the dev branch of the protobuf submodule and pull the latest version:
|
|
@@ -132,7 +132,7 @@ If the pull request requires changes in the carta-protobuf submodule and is read
|
|
|
132
132
|
4. Commit and push the changes:
|
|
133
133
|
|
|
134
134
|
```
|
|
135
|
-
git
|
|
135
|
+
git commit -a -m "update protobuf"
|
|
136
136
|
git push
|
|
137
137
|
```
|
|
138
138
|
|
|
@@ -10,29 +10,29 @@ In this document, 123 is a placeholder for the current release number, and 124 f
|
|
|
10
10
|
|
|
11
11
|
### Beta release
|
|
12
12
|
|
|
13
|
-
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.
|
|
13
|
+
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.0`.
|
|
14
14
|
2. `dev` branch: update the user manual URL if necessary.
|
|
15
15
|
3. Create a `release/123.0` branch using the `dev` branch.
|
|
16
|
-
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.
|
|
17
|
-
5. Create a `v123.0.0-beta.
|
|
16
|
+
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.0`. Run `npm install` to update `package-lock.json`.
|
|
17
|
+
5. Create a `v123.0.0-beta.0` tag using the release branch.
|
|
18
18
|
6. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
19
19
|
7. Create packages from the release branch.
|
|
20
20
|
|
|
21
21
|
### After beta release
|
|
22
22
|
|
|
23
23
|
1. `dev` branch: update `CHANGELOG.md`. Create a new `Unreleased` section.
|
|
24
|
-
2. `dev` branch: update the documentation website ([guidelines](./documentation-guidelines/#Versioning)). Create a new version `123.0.0-beta.
|
|
24
|
+
2. `dev` branch: update the documentation website ([guidelines](./documentation-guidelines/#Versioning)). Create a new version `123.0.0-beta.0`.
|
|
25
25
|
|
|
26
26
|
### Additional beta release
|
|
27
27
|
|
|
28
28
|
This process should be followed if changes have to be made after the beta packages have already been published (or even provided to a limited number of users). If there are significant changes in `dev` that should _not_ be included in the beta release, follow the point release procedure instead (but adjust the version strings as required).
|
|
29
29
|
|
|
30
30
|
1. Make the required fixes in `dev`.
|
|
31
|
-
2. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.
|
|
31
|
+
2. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.1`.
|
|
32
32
|
3. `dev` branch: update the user manual URL if necessary.
|
|
33
33
|
4. Merge the `dev` branch into the `release/123.0` branch.
|
|
34
|
-
5. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.
|
|
35
|
-
6. Create a `v123.0.0-beta.
|
|
34
|
+
5. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.1`. Run `npm install` to update `package-lock.json`.
|
|
35
|
+
6. Create a `v123.0.0-beta.1` tag using the release branch.
|
|
36
36
|
7. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
37
37
|
8. Create packages from the release branch.
|
|
38
38
|
|
|
@@ -43,8 +43,8 @@ This process should be followed if changes have to be made after the beta packag
|
|
|
43
43
|
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0`.
|
|
44
44
|
2. `dev` branch: update the user manual URL if necessary.
|
|
45
45
|
3. Merge the `dev` branch into the `release/123.0` branch.
|
|
46
|
-
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-rc.
|
|
47
|
-
5. Create a `v123.0.0-rc.
|
|
46
|
+
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-rc.0`. Run `npm install` to update `package-lock.json`.
|
|
47
|
+
5. Create a `v123.0.0-rc.0` tag using the release branch.
|
|
48
48
|
6. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
49
49
|
7. `release/123.0` branch: update the `package.json` version string to `123.0.0`. Run `npm install` to update `package-lock.json`.
|
|
50
50
|
8. Create a `v123.0.0` tag using the release branch.
|
|
@@ -79,4 +79,4 @@ app.closeFile(file1, false); // No user confirmation
|
|
|
79
79
|
app.closeOtherFiles(file2);
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
For all functions and objects
|
|
82
|
+
For all functions and objects available in the <ApiLink path="/.-stores/class/AppStore">`app`</ApiLink> object, please refer to the <ApiLink path="/.-stores/class/AppStore">API documentation</ApiLink>.
|
|
@@ -14,7 +14,7 @@ const file = await app.openFile("my_image.fits");
|
|
|
14
14
|
|
|
15
15
|
## Creating regions
|
|
16
16
|
|
|
17
|
-
Regions on a specific image
|
|
17
|
+
Regions on a specific image are accessible via <ApiLink path="/.-stores/class/RegionSetStore">`RegionSetStore`</ApiLink> under each image. Each region is represented by a <ApiLink path="/.-stores/class/RegionStore">`RegionStore`</ApiLink> object.
|
|
18
18
|
|
|
19
19
|
```javascript
|
|
20
20
|
console.log(file.regionSet.regions); // View all regions
|
|
@@ -10,7 +10,7 @@ The workflow for contributing to the codebase.
|
|
|
10
10
|
|
|
11
11
|
When creating new issues, please refer to [this page](https://github.com/CARTAvis/carta-frontend/labels) for the available labels that can be added.
|
|
12
12
|
|
|
13
|
-
If the issue is related to bug fixing, please use the [bug report template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/ISSUE_TEMPLATE/bug_report.md). Please make sure to fill in the template with all the necessary information, including the description, reproduction steps, and platform information. Providing reproduction steps is particularly helpful for
|
|
13
|
+
If the issue is related to bug fixing, please use the [bug report template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/ISSUE_TEMPLATE/bug_report.md). Please make sure to fill in the template with all the necessary information, including the description, reproduction steps, and platform information. Providing reproduction steps is particularly helpful for resolving issues. Additionally, including testing images can be helpful for reproducing the issue.
|
|
14
14
|
|
|
15
15
|
## Contributing to the codebase
|
|
16
16
|
|
|
@@ -53,7 +53,7 @@ git push
|
|
|
53
53
|
|
|
54
54
|
#### Pull request template
|
|
55
55
|
|
|
56
|
-
When making a pull request from
|
|
56
|
+
When making a pull request from your branch, please use the [pull request template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/pull_request_template.md).
|
|
57
57
|
|
|
58
58
|
In the description section, please provide details about your changes, including linked issues and companion pull requests (if there are), what is implemented or fixed, and how to test it.
|
|
59
59
|
|
|
@@ -117,7 +117,7 @@ If the pull request requires changes in the carta-protobuf submodule and is read
|
|
|
117
117
|
2. Check out the frontend branch:
|
|
118
118
|
|
|
119
119
|
```
|
|
120
|
-
git checkout
|
|
120
|
+
git checkout [the frontend branch]
|
|
121
121
|
```
|
|
122
122
|
|
|
123
123
|
3. Check out the dev branch of the protobuf submodule and pull the latest version:
|
|
@@ -132,7 +132,7 @@ If the pull request requires changes in the carta-protobuf submodule and is read
|
|
|
132
132
|
4. Commit and push the changes:
|
|
133
133
|
|
|
134
134
|
```
|
|
135
|
-
git
|
|
135
|
+
git commit -a -m "update protobuf"
|
|
136
136
|
git push
|
|
137
137
|
```
|
|
138
138
|
|
|
@@ -10,29 +10,29 @@ In this document, 123 is a placeholder for the current release number, and 124 f
|
|
|
10
10
|
|
|
11
11
|
### Beta release
|
|
12
12
|
|
|
13
|
-
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.
|
|
13
|
+
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.0`.
|
|
14
14
|
2. `dev` branch: update the user manual URL if necessary.
|
|
15
15
|
3. Create a `release/123.0` branch using the `dev` branch.
|
|
16
|
-
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.
|
|
17
|
-
5. Create a `v123.0.0-beta.
|
|
16
|
+
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.0`. Run `npm install` to update `package-lock.json`.
|
|
17
|
+
5. Create a `v123.0.0-beta.0` tag using the release branch.
|
|
18
18
|
6. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
19
19
|
7. Create packages from the release branch.
|
|
20
20
|
|
|
21
21
|
### After beta release
|
|
22
22
|
|
|
23
23
|
1. `dev` branch: update `CHANGELOG.md`. Create a new `Unreleased` section.
|
|
24
|
-
2. `dev` branch: update the documentation website ([guidelines](./documentation-guidelines/#Versioning)). Create a new version `123.0.0-beta.
|
|
24
|
+
2. `dev` branch: update the documentation website ([guidelines](./documentation-guidelines/#Versioning)). Create a new version `123.0.0-beta.0`.
|
|
25
25
|
|
|
26
26
|
### Additional beta release
|
|
27
27
|
|
|
28
28
|
This process should be followed if changes have to be made after the beta packages have already been published (or even provided to a limited number of users). If there are significant changes in `dev` that should _not_ be included in the beta release, follow the point release procedure instead (but adjust the version strings as required).
|
|
29
29
|
|
|
30
30
|
1. Make the required fixes in `dev`.
|
|
31
|
-
2. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.
|
|
31
|
+
2. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.1`.
|
|
32
32
|
3. `dev` branch: update the user manual URL if necessary.
|
|
33
33
|
4. Merge the `dev` branch into the `release/123.0` branch.
|
|
34
|
-
5. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.
|
|
35
|
-
6. Create a `v123.0.0-beta.
|
|
34
|
+
5. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.1`. Run `npm install` to update `package-lock.json`.
|
|
35
|
+
6. Create a `v123.0.0-beta.1` tag using the release branch.
|
|
36
36
|
7. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
37
37
|
8. Create packages from the release branch.
|
|
38
38
|
|
|
@@ -43,8 +43,8 @@ This process should be followed if changes have to be made after the beta packag
|
|
|
43
43
|
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0`.
|
|
44
44
|
2. `dev` branch: update the user manual URL if necessary.
|
|
45
45
|
3. Merge the `dev` branch into the `release/123.0` branch.
|
|
46
|
-
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-rc.
|
|
47
|
-
5. Create a `v123.0.0-rc.
|
|
46
|
+
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-rc.0`. Run `npm install` to update `package-lock.json`.
|
|
47
|
+
5. Create a `v123.0.0-rc.0` tag using the release branch.
|
|
48
48
|
6. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
49
49
|
7. `release/123.0` branch: update the `package.json` version string to `123.0.0`. Run `npm install` to update `package-lock.json`.
|
|
50
50
|
8. Create a `v123.0.0` tag using the release branch.
|
package/docs_website/versioned_docs/version-5.0.0-beta.1c/code-snippet-tutorial/quick-start.mdx
CHANGED
|
@@ -79,4 +79,4 @@ app.closeFile(file1, false); // No user confirmation
|
|
|
79
79
|
app.closeOtherFiles(file2);
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
For all functions and objects
|
|
82
|
+
For all functions and objects available in the <ApiLink path="/.-stores/class/AppStore">`app`</ApiLink> object, please refer to the <ApiLink path="/.-stores/class/AppStore">API documentation</ApiLink>.
|
|
@@ -14,7 +14,7 @@ const file = await app.openFile("my_image.fits");
|
|
|
14
14
|
|
|
15
15
|
## Creating regions
|
|
16
16
|
|
|
17
|
-
Regions on a specific image
|
|
17
|
+
Regions on a specific image are accessible via <ApiLink path="/.-stores/class/RegionSetStore">`RegionSetStore`</ApiLink> under each image. Each region is represented by a <ApiLink path="/.-stores/class/RegionStore">`RegionStore`</ApiLink> object.
|
|
18
18
|
|
|
19
19
|
```javascript
|
|
20
20
|
console.log(file.regionSet.regions); // View all regions
|
|
@@ -10,7 +10,7 @@ The workflow for contributing to the codebase.
|
|
|
10
10
|
|
|
11
11
|
When creating new issues, please refer to [this page](https://github.com/CARTAvis/carta-frontend/labels) for the available labels that can be added.
|
|
12
12
|
|
|
13
|
-
If the issue is related to bug fixing, please use the [bug report template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/ISSUE_TEMPLATE/bug_report.md). Please make sure to fill in the template with all the necessary information, including the description, reproduction steps, and platform information. Providing reproduction steps is particularly helpful for
|
|
13
|
+
If the issue is related to bug fixing, please use the [bug report template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/ISSUE_TEMPLATE/bug_report.md). Please make sure to fill in the template with all the necessary information, including the description, reproduction steps, and platform information. Providing reproduction steps is particularly helpful for resolving issues. Additionally, including testing images can be helpful for reproducing the issue.
|
|
14
14
|
|
|
15
15
|
## Contributing to the codebase
|
|
16
16
|
|
|
@@ -53,7 +53,7 @@ git push
|
|
|
53
53
|
|
|
54
54
|
#### Pull request template
|
|
55
55
|
|
|
56
|
-
When making a pull request from
|
|
56
|
+
When making a pull request from your branch, please use the [pull request template](https://github.com/CARTAvis/carta-frontend/blob/dev/.github/pull_request_template.md).
|
|
57
57
|
|
|
58
58
|
In the description section, please provide details about your changes, including linked issues and companion pull requests (if there are), what is implemented or fixed, and how to test it.
|
|
59
59
|
|
|
@@ -117,7 +117,7 @@ If the pull request requires changes in the carta-protobuf submodule and is read
|
|
|
117
117
|
2. Check out the frontend branch:
|
|
118
118
|
|
|
119
119
|
```
|
|
120
|
-
git checkout
|
|
120
|
+
git checkout [the frontend branch]
|
|
121
121
|
```
|
|
122
122
|
|
|
123
123
|
3. Check out the dev branch of the protobuf submodule and pull the latest version:
|
|
@@ -132,7 +132,7 @@ If the pull request requires changes in the carta-protobuf submodule and is read
|
|
|
132
132
|
4. Commit and push the changes:
|
|
133
133
|
|
|
134
134
|
```
|
|
135
|
-
git
|
|
135
|
+
git commit -a -m "update protobuf"
|
|
136
136
|
git push
|
|
137
137
|
```
|
|
138
138
|
|
package/docs_website/versioned_docs/version-5.0.0-beta.1c/contributing/release-guidelines.md
CHANGED
|
@@ -10,29 +10,29 @@ In this document, 123 is a placeholder for the current release number, and 124 f
|
|
|
10
10
|
|
|
11
11
|
### Beta release
|
|
12
12
|
|
|
13
|
-
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.
|
|
13
|
+
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.0`.
|
|
14
14
|
2. `dev` branch: update the user manual URL if necessary.
|
|
15
15
|
3. Create a `release/123.0` branch using the `dev` branch.
|
|
16
|
-
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.
|
|
17
|
-
5. Create a `v123.0.0-beta.
|
|
16
|
+
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.0`. Run `npm install` to update `package-lock.json`.
|
|
17
|
+
5. Create a `v123.0.0-beta.0` tag using the release branch.
|
|
18
18
|
6. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
19
19
|
7. Create packages from the release branch.
|
|
20
20
|
|
|
21
21
|
### After beta release
|
|
22
22
|
|
|
23
23
|
1. `dev` branch: update `CHANGELOG.md`. Create a new `Unreleased` section.
|
|
24
|
-
2. `dev` branch: update the documentation website ([guidelines](./documentation-guidelines/#Versioning)). Create a new version `123.0.0-beta.
|
|
24
|
+
2. `dev` branch: update the documentation website ([guidelines](./documentation-guidelines/#Versioning)). Create a new version `123.0.0-beta.0`.
|
|
25
25
|
|
|
26
26
|
### Additional beta release
|
|
27
27
|
|
|
28
28
|
This process should be followed if changes have to be made after the beta packages have already been published (or even provided to a limited number of users). If there are significant changes in `dev` that should _not_ be included in the beta release, follow the point release procedure instead (but adjust the version strings as required).
|
|
29
29
|
|
|
30
30
|
1. Make the required fixes in `dev`.
|
|
31
|
-
2. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.
|
|
31
|
+
2. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0-beta.1`.
|
|
32
32
|
3. `dev` branch: update the user manual URL if necessary.
|
|
33
33
|
4. Merge the `dev` branch into the `release/123.0` branch.
|
|
34
|
-
5. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.
|
|
35
|
-
6. Create a `v123.0.0-beta.
|
|
34
|
+
5. `release/123.0` branch: update the `package.json` version string to `123.0.0-beta.1`. Run `npm install` to update `package-lock.json`.
|
|
35
|
+
6. Create a `v123.0.0-beta.1` tag using the release branch.
|
|
36
36
|
7. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
37
37
|
8. Create packages from the release branch.
|
|
38
38
|
|
|
@@ -43,8 +43,8 @@ This process should be followed if changes have to be made after the beta packag
|
|
|
43
43
|
1. `dev` branch: update `CHANGELOG.md`. Change the `Unreleased` heading to `123.0.0`.
|
|
44
44
|
2. `dev` branch: update the user manual URL if necessary.
|
|
45
45
|
3. Merge the `dev` branch into the `release/123.0` branch.
|
|
46
|
-
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-rc.
|
|
47
|
-
5. Create a `v123.0.0-rc.
|
|
46
|
+
4. `release/123.0` branch: update the `package.json` version string to `123.0.0-rc.0`. Run `npm install` to update `package-lock.json`.
|
|
47
|
+
5. Create a `v123.0.0-rc.0` tag using the release branch.
|
|
48
48
|
6. Test the release branch. Make any required fixes in the `dev` branch, and merge them into the release branch. Ideally, bump the version and create a new tag every time changes are merged. If you don't want to bump the version, remember to destroy and recreate the latest tag.
|
|
49
49
|
7. `release/123.0` branch: update the `package.json` version string to `123.0.0`. Run `npm install` to update `package-lock.json`.
|
|
50
50
|
8. Create a `v123.0.0` tag using the release branch.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "carta-frontend",
|
|
3
|
-
"version": "5.0.0
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"repository": "https://github.com/CARTAvis/carta-frontend",
|
|
5
5
|
"description": "The browser-based frontend component of CARTA, a radio-astronomy visualization tool designed for the ALMA, the VLA and the SKA pathfinders.",
|
|
6
6
|
"homepage": "./",
|
|
@@ -88,9 +88,9 @@
|
|
|
88
88
|
"analyze": "source-map-explorer build/static/js/main.*",
|
|
89
89
|
"postinstall": "patch-package",
|
|
90
90
|
"start": "npm run git-info; npm run strict-null-checks && react-scripts start",
|
|
91
|
-
"build": "npm run git-info; npm-run-all build-wrappers build-protobuf build-ts",
|
|
92
|
-
"build-docker": "npm run git-info; npm-run-all build-wrappers-docker build-protobuf build-ts",
|
|
93
|
-
"build-singularity": "npm run git-info; npm-run-all build-wrappers-singularity build-protobuf build-ts",
|
|
91
|
+
"build": "npm run git-info; npm-run-all build-wrappers build-protobuf link-schemas build-ts",
|
|
92
|
+
"build-docker": "npm run git-info; npm-run-all build-wrappers-docker build-protobuf link-schemas build-ts",
|
|
93
|
+
"build-singularity": "npm run git-info; npm-run-all build-wrappers-singularity build-protobuf link-schemas build-ts",
|
|
94
94
|
"build-ts": "npm run strict-null-checks && react-scripts --max_old_space_size=4096 build",
|
|
95
95
|
"build-libs": "./wasm_libs/build_libs.sh",
|
|
96
96
|
"build-libs-docker": "./build_wasm_libs_docker.sh",
|
|
@@ -99,6 +99,7 @@
|
|
|
99
99
|
"build-wrappers-docker": "./build_wasm_wrappers_docker.sh",
|
|
100
100
|
"build-wrappers-singularity": "./build_wasm_wrappers_singularity.sh",
|
|
101
101
|
"build-protobuf": "./protobuf/build_proto.sh",
|
|
102
|
+
"link-schemas": "./schemas/link_schemas.sh",
|
|
102
103
|
"test": "react-scripts test --env=jsdom",
|
|
103
104
|
"eject": "react-scripts eject",
|
|
104
105
|
"reformat": "npx prettier --write ./src",
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
name: Add new issues and pull requests to CartaVis Board project
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
issues:
|
|
5
|
+
types:
|
|
6
|
+
- opened
|
|
7
|
+
- reopened
|
|
8
|
+
pull_request:
|
|
9
|
+
types:
|
|
10
|
+
- opened
|
|
11
|
+
- reopened
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
add-to-project:
|
|
15
|
+
name: Add issue to project
|
|
16
|
+
runs-on: ubuntu-latest
|
|
17
|
+
steps:
|
|
18
|
+
- uses: actions/add-to-project@v0.6.1
|
|
19
|
+
with:
|
|
20
|
+
# You can target a project in a different organization
|
|
21
|
+
# to the issue
|
|
22
|
+
project-url: https://github.com/orgs/CARTAvis/projects/11
|
|
23
|
+
github-token: ${{ secrets.ADD_TO_CARTA_BOARD_PROJECT_PAT }}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"arrowParens": "avoid",
|
|
3
|
+
"bracketSpacing": false,
|
|
4
|
+
"embeddedLanguageFormatting": "auto",
|
|
5
|
+
"htmlWhitespaceSensitivity": "css",
|
|
6
|
+
"insertPragma": false,
|
|
7
|
+
"bracketSameLine": false,
|
|
8
|
+
"jsxSingleQuote": false,
|
|
9
|
+
"proseWrap": "preserve",
|
|
10
|
+
"quoteProps": "as-needed",
|
|
11
|
+
"requirePragma": false,
|
|
12
|
+
"semi": true,
|
|
13
|
+
"singleQuote": false,
|
|
14
|
+
"trailingComma": "none",
|
|
15
|
+
"useTabs": false,
|
|
16
|
+
"printWidth": 240,
|
|
17
|
+
"tabWidth": 4
|
|
18
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
ADD_EXECUTABLE(schemacompiler schemacompiler.c)
|
|
2
|
+
FILE(GLOB SCHEMA_FILES CONFIGURE_DEPENDS "*_schema_*.json")
|
|
3
|
+
|
|
4
|
+
FOREACH(INPUT_FILE ${SCHEMA_FILES})
|
|
5
|
+
CMAKE_PATH(GET INPUT_FILE FILENAME OUTPUT_FILE)
|
|
6
|
+
STRING(APPEND OUTPUT_FILE ".h")
|
|
7
|
+
ADD_CUSTOM_COMMAND(
|
|
8
|
+
OUTPUT ${OUTPUT_FILE}
|
|
9
|
+
DEPENDS schemacompiler ${INPUT_FILE}
|
|
10
|
+
COMMAND schemacompiler ${INPUT_FILE} ${OUTPUT_FILE}
|
|
11
|
+
)
|
|
12
|
+
LIST(APPEND SCHEMA_HEADERS ${OUTPUT_FILE})
|
|
13
|
+
ENDFOREACH()
|
|
14
|
+
|
|
15
|
+
ADD_LIBRARY(carta-schemas INTERFACE ${SCHEMA_HEADERS})
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
This is a directory of JSON schemas used by CARTA components, published automatically from a [source repository](https://github.com/CARTAvis/schemas).
|