Skip to content

Commit d9a4134

Browse files
authored
Merge branch 'develop' into feat/action-versioning
2 parents fcb7dd6 + b3d2280 commit d9a4134

14 files changed

Lines changed: 36 additions & 36 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Please help us process issues more efficiently by filing an issue using one of the following templates:
22

3-
https://github.com/NASA-AMMOS/aerie/issues/new/choose
3+
https://github.com/NASA-AMMOS/plandev/issues/new/choose
44

55
Thank you!

.github/ISSUE_TEMPLATE/2-feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ body:
55
- type: markdown
66
attributes:
77
value: |
8-
Thanks for taking the time to request this feature! If your feature request is complex or substantial enough to warrant in-depth discussion, maintainers may close the issue and ask you to open a [Discussion](https://github.com/NASA-AMMOS/aerie/discussions).
8+
Thanks for taking the time to request this feature! If your feature request is complex or substantial enough to warrant in-depth discussion, maintainers may close the issue and ask you to open a [Discussion](https://github.com/NASA-AMMOS/plandev/discussions).
99
- type: dropdown
1010
id: checked-for-duplicates
1111
attributes:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: PlanDev UI
4-
url: https://github.com/NASA-AMMOS/aerie-ui/issues/new/choose
4+
url: https://github.com/NASA-AMMOS/plandev-ui/issues/new/choose
55
about: Issues and feature requests for the PlanDev UI repo (not backend related).
66
- name: PlanDev Docs
77
url: https://github.com/NASA-AMMOS/plandev-docs/issues/new/choose

.github/config/.trivyignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# which is installed by the postgres docker container and does not use the entirety of the Go stdlib
66
# for details see:
77
# - https://github.com/tianon/gosu/blob/master/SECURITY.md
8-
# - https://github.com/NASA-AMMOS/aerie/pull/1546
8+
# - https://github.com/NASA-AMMOS/plandev/pull/1546
99
# - https://github.com/tianon/gosu/pull/173#issuecomment-3936440684
1010
CVE-2023-24538
1111
CVE-2023-24540

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,5 +88,5 @@ The scripts and documentation in this project are released under the [MIT Licens
8888
[deployment]: ./deployment
8989
[dev]: ./docs/DEVELOPER.md
9090
[fast-track]: https://nasa-ammos.github.io/plandev-docs/introduction/#fast-track
91-
[ui-repo]: https://github.com/NASA-AMMOS/aerie-ui
91+
[ui-repo]: https://github.com/NASA-AMMOS/plandev-ui
9292

deployment/Environment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This document provides detailed information about environment variables for each
1313

1414
## PlanDev Gateway
1515

16-
See the [environment variables document](https://github.com/NASA-AMMOS/aerie-gateway/blob/develop/docs/ENVIRONMENT.md) in the PlanDev Gateway repository.
16+
See the [environment variables document](https://github.com/NASA-AMMOS/plandev-gateway/blob/develop/docs/ENVIRONMENT.md) in the PlanDev Gateway repository.
1717

1818
## PlanDev Merlin
1919

@@ -105,7 +105,7 @@ See the [environment variables document](https://github.com/NASA-AMMOS/aerie-gat
105105

106106
## PlanDev UI
107107

108-
See the [environment variables document](https://github.com/NASA-AMMOS/aerie-ui/blob/develop/docs/ENVIRONMENT.md) in the PlanDev UI repository.
108+
See the [environment variables document](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/ENVIRONMENT.md) in the PlanDev UI repository.
109109

110110
## Hasura
111111

deployment/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ does not exceed the host's remaining available cores (considering other processe
5050

5151
## Starting the Services
5252

53-
Download and unzip the latest [Deployment.zip](https://github.com/NASA-AMMOS/aerie/releases) file onto your local machine, then do:
53+
Download and unzip the latest [Deployment.zip](https://github.com/NASA-AMMOS/plandev/releases) file onto your local machine, then do:
5454

5555
```sh
5656
cd deployment
@@ -72,4 +72,4 @@ docker-compose down
7272
## Troubleshooting
7373

7474
- Make sure you are starting all the Docker containers in a clean environment. This means before starting the services make sure all containers are removed, all images are removed, and all volumes are removed.
75-
- If you are having trouble and cannot find the answer here, please contact someone from the PlanDev team via the [#mpsa-aerie-users](https://app.slack.com/client/T024LMMEZ/C0163E42UBF) Slack channel.
75+
- If you are having trouble and cannot find the answer here, please contact someone from the PlanDev team via the [#mpsa-plandev-users](https://app.slack.com/client/T024LMMEZ/C0163E42UBF) Slack channel.

docs/CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ The PlanDev project relies on the ability to effectively query the Git history.
5151

5252
Please follow these instructions when submitting a Pull Request:
5353

54-
1. Search [GitHub](https://github.com/NASA-AMMOS/aerie/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.
54+
1. Search [GitHub](https://github.com/NASA-AMMOS/plandev/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.
5555
1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.
56-
1. Clone the [PlanDev repo](https://github.com/NASA-AMMOS/aerie).
56+
1. Clone the [PlanDev repo](https://github.com/NASA-AMMOS/plandev).
5757
1. Make your changes in a new git branch:
5858

5959
```sh
@@ -77,7 +77,7 @@ Please follow these instructions when submitting a Pull Request:
7777
git push origin my-fix-branch
7878
```
7979

80-
1. In GitHub, send a pull request to `aerie:develop`.
80+
1. In GitHub, send a pull request to `plandev:develop`.
8181
1. If we suggest changes then:
8282

8383
- Make the required updates.
@@ -110,27 +110,27 @@ After your pull request is merged, you can safely delete your branch and pull th
110110

111111
## <a name="submit-pr"></a> Required Checks on PRs
112112

113-
When you submit a PR, we use Github Workflows to automatically run a number of CI-type checks on it, all of which must pass before the PR can be merged. These vary slightly from one repo to another, but mostly consist of unit tests, as well as end-to-end (e2e) tests for the backend and frontend (`aerie` and `aerie-ui`) repos. If your PR adds new tests to our existing test suites, they will automatically be run & validated with your PR.
113+
When you submit a PR, we use Github Workflows to automatically run a number of CI-type checks on it, all of which must pass before the PR can be merged. These vary slightly from one repo to another, but mostly consist of unit tests, as well as end-to-end (e2e) tests for the backend and frontend (`plandev` and `plandev-ui`) repos. If your PR adds new tests to our existing test suites, they will automatically be run & validated with your PR.
114114

115115
You can see the status of these checks at the bottom of the PR on Github - it should say "All checks have passed" if all is well. If it says "Some checks are not successful", you'll need to troubleshoot the cause of the failure before your PR can be accepted. Click "show all checks", then "details" to get detailed server logs from every step of the GH action that failed. Note that some of these runs may also have *files attached* to the run, which contain more detailed logs.
116116

117117
If you can't determine the cause of the failure from logs alone, it may be helpful to try and reproduce the problem locally. You can see the commands run by the Required Check actions by looking in each repo under `.github/workflows` - each `yml` file in this folder contains the setup & commands necessary to run the check locally yourself.
118118

119119
## <a name="submit-pr"></a> Running E2E Tests with specific branches/images
120120

121-
Both `aerie` and `aerie-ui` repos contain **end-to-end (E2E) tests** which depend on code from other PlanDev repos. Specifically:
122-
- The `aerie` backend e2e test suite, which tests a fully running PlanDev API, depends on `aerie-gateway` since it is part of the API
123-
- The `aerie-ui` e2e suite, which tests a full PlanDev UI + backend, depends on `aerie` and `aerie-gateway` code since it is a full stack test
121+
Both `plandev` and `plandev-ui` repos contain **end-to-end (E2E) tests** which depend on code from other PlanDev repos. Specifically:
122+
- The `plandev` backend e2e test suite, which tests a fully running PlanDev API, depends on `plandev-gateway` since it is part of the API
123+
- The `plandev-ui` e2e suite, which tests a full PlanDev UI + backend, depends on `plandev` and `plandev-gateway` code since it is a full stack test
124124

125125
Sometimes a new feature requires code changes in *multiple repos simultaneously*, eg. a UI PR may add a new UI element that displays a new database field, but relies on a corresponding backend PR to add the new field. In this case, the UI PR's e2e tests will fail unless it has a way to *specify* which backend PR(s)/branches should be used for the e2e test.
126126

127127
To handle this situation, follow these steps with your PRs:
128-
1. When you submit an `aerie` or `aerie-gateway` PR, if your PR contains code that *other PRs depend on*, add the GH label **"publish"** to the PR. This will cause an additional workflow to run which *publishes* the code in that branch to a docker image called eg. `pr-9999` for use by other PRs.
129-
2. When you submit an `aerie-ui` or `aerie` PR, if it *depends on other PR(s)* (aerie or gateway) for its tests to pass, edit the **body of your PR** to contain one or both of the following lines:
128+
1. When you submit a `plandev` or `plandev-gateway` PR, if your PR contains code that *other PRs depend on*, add the GH label **"publish"** to the PR. This will cause an additional workflow to run which *publishes* the code in that branch to a docker image called eg. `pr-9999` for use by other PRs.
129+
2. When you submit an `plandev-ui` or `plandev` PR, if it *depends on other PR(s)* (plandev or gateway) for its tests to pass, edit the **body of your PR** to contain one or both of the following lines:
130130
```
131131
___REQUIRES_AERIE_PR___="9999"
132132
___REQUIRES_GATEWAY_PR___="9999"
133133
```
134-
Replace "9999" with the **PR number(s)** of the relevant `aerie`/`gateway` PR(s). PRs to `aerie-ui` allow either/both of these fields, while `aerie` PRs only allow a `gateway` PR to be specified.
134+
Replace "9999" with the **PR number(s)** of the relevant `plandev`/`gateway` PR(s). PRs to `plandev-ui` allow either/both of these fields, while `plandev` PRs only allow a `gateway` PR to be specified.
135135

136-
For example, see [this PR](https://github.com/NASA-AMMOS/aerie-ui/pull/1420) or [this PR](https://github.com/NASA-AMMOS/aerie-ui/pull/1492).
136+
For example, see [this PR](https://github.com/NASA-AMMOS/plandev-ui/pull/1420) or [this PR](https://github.com/NASA-AMMOS/plandev-ui/pull/1492).

docs/DEVELOPER.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,21 +51,21 @@ If you use [IntelliJ IDEA](https://www.jetbrains.com/idea/), you can import the
5151
[Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the PlanDev repository:
5252

5353
```shell
54-
git clone https://github.com/NASA-AMMOS/aerie.git
55-
cd aerie
54+
git clone https://github.com/NASA-AMMOS/plandev.git
55+
cd plandev
5656
```
5757

5858
## Building
5959

6060
```sh
61-
cd aerie
61+
cd plandev
6262
./gradlew assemble
6363
```
6464

6565
## Testing
6666

6767
```sh
68-
cd aerie
68+
cd plandev
6969
./gradlew test
7070
```
7171

@@ -74,7 +74,7 @@ cd aerie
7474
Use the following task to print a report of the dependencies that have updates available.
7575

7676
```sh
77-
cd aerie
77+
cd plandev
7878
./gradlew dependencyUpdates
7979
```
8080

@@ -83,7 +83,7 @@ cd aerie
8383
To run the PlanDev services you need to first set the proper environment variables. First copy the template:
8484

8585
```sh
86-
cd aerie
86+
cd plandev
8787
cp .env.template .env
8888
```
8989

@@ -103,16 +103,16 @@ POSTGRES_USER=postgres
103103
The [docker-compose.yml](../docker-compose.yml) in the root directory deploys PlanDev locally, creating containers using the artifacts from the build step above.
104104

105105
```sh
106-
cd aerie
106+
cd plandev
107107
docker-compose up --build --detach
108108
```
109109

110-
Once PlanDev is started you can visit [http://localhost](http://localhost) to view the [PlanDev UI](https://github.com/NASA-AMMOS/aerie-ui). You can visit [http://localhost:8080](http://localhost:8080) to view the [Hasura Console](https://hasura.io/).
110+
Once PlanDev is started you can visit [http://localhost](http://localhost) to view the [PlanDev UI](https://github.com/NASA-AMMOS/plandev-ui). You can visit [http://localhost:8080](http://localhost:8080) to view the [Hasura Console](https://hasura.io/).
111111

112112
## Stop PlanDev
113113

114114
```sh
115-
cd aerie
115+
cd plandev
116116
docker compose down
117117
```
118118

docs/GOVERNANCE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Anyone who has downloaded, deployed, or operated the PlanDev system to meet a sp
1212

1313
### Contributor
1414

15-
Contributors include anyone that provides input to the project. This includes code, issues, documentation, graphics, designs, or anything else that tangibly improves the project. We encourage you to start contributing right away by joining our [Discussions](https://github.com/NASA-AMMOS/aerie/discussions) or submitting an [Issue](https://github.com/NASA-AMMOS/aerie/issues).
15+
Contributors include anyone that provides input to the project. This includes code, issues, documentation, graphics, designs, or anything else that tangibly improves the project. We encourage you to start contributing right away by joining our [Discussions](https://github.com/NASA-AMMOS/plandev/discussions) or submitting an [Issue](https://github.com/NASA-AMMOS/plandev/issues).
1616

1717
### Triager
1818

@@ -61,8 +61,8 @@ A subset of the collaborators forms the Technical Steering Committee (TSC). The
6161

6262
The TSC is primarily responsible for the PlanDev core and UI projects:
6363

64-
- https://github.com/NASA-AMMOS/aerie
65-
- https://github.com/NASA-AMMOS/aerie-ui
64+
- https://github.com/NASA-AMMOS/plandev
65+
- https://github.com/NASA-AMMOS/plandev-ui
6666

6767
However, the TSC also has responsibility over some projects, which are dependencies of the core projects:
6868

0 commit comments

Comments
 (0)