chore: initial deploy for code base

This commit is contained in:
Thom Lamb
2026-05-12 09:39:01 -05:00
parent 6b355f82d1
commit 0a80e96b32
345 changed files with 37208 additions and 1 deletions
+35 -1
View File
@@ -1,2 +1,36 @@
# tempo
# Tempo
## Prerequisites
1. Make sure you have followed ALL steps in this confluence https://confluence.sdt.local/display/SWPRJ/Setting+up+React and that your npm/node versions are as follows:
* npm- 6.14.16
* node- v14.19.1
2. Clone the tempo and tempodocsite repositories.
## Making Changes
1. Branch off Development **(do not branch off Main)** and make your changes. If you are creating a new feature use `feature/tempo/jira-ticket-goes-here` if you are creating a hot fix use `fix/tempo/jira-ticket-goes-here`.
2. If this is your first time working in the repo you will need to run `npm install`.
3. Make the changes/fixes/updates you need as part of your item.
4. Run `npm run wbp` to build Tempo and create the updated `tempo.api.md` file. This is a must do in order to create the latest markdown/metadata file that others consume when using tempo.
5. Commit your tempo changes to your branch and push.
6. Create a branch off Main in the docsite repo https://github.com/stratadecision/tempodocsiteweb as there is no development branch there.
7. If this is your first time working in the repo you will need to run `npm install`
8. To use your tempo changes in your docsite branch, npm install the pre-release version of those changes from your tempo branch. You can view the pre-release versions by going here to proget https://proget.sdt.local/feeds/npm/@strata/tempo/versions/all. Run `npm run start` to view localhost version of docsite and see your changes.
9. If there are issues with your tempo changes, return to step 3 and make updates in your tempo repo branch. Repeat steps 3-5 along with installing the newest pre-release version of your tempo branch until your tempo changes work as you'd expect.
10. Once you have the tempo changes finished update the docsite by adding new examples/updating existing examples/etc as it applies to the scope of your changes.
11. After verifying your tempo changes work, create a tempo PR pointed at development branch, the codeowners file will automatically put required reviewers on the PR.
**Make sure you are pointing your PR to Development and not Main**
12. Create a docsite PR with your changes, the codeowners file will automatically put required reviews on the PR.
13. Once Carmen & Jacky have approved your Tempo PR merge it into development.
14. After your Tempo PR is merged into development and the build has finished, run `npm install @strata/tempo@beta` in your docsite branch. Commit the package.json and package-lock.json changes.
15. Once Carmen & Jacky have approved your docsite PR, merge it. Once your Docsite PR is merged and the build has finished, you can see your change in Docsite Beta url. https://tempo-beta.dev.stratanetwork.net/
## Build Status
[![build](https://github.com/stratadecision/tempo/actions/workflows/build.yaml/badge.svg)](https://github.com/stratadecision/tempo/actions/workflows/build.yaml)
## Branching and Versioning
| branch | version format | example |
| ---------- | --------------------- | --------------- |
| master | #.#.# | 1.2.3 |
| feature/\* | #.#+1.0-featureName.# | 1.3.0-newfeat.1 |
| fix/\* | #.#.#+1-fixName.# | 1.2.4-bug.1 |
See our [confluence page](https://confluence.sdt.local/display/DOP/Branching+and+Versioning) for more information