Merge pull request #356 from shapehq/develop

Deploy to production

Author: simonbs

.env.example

@@ -1,15 +1,15 @@
-SHAPE_DOCS_BASE_URL=http://localhost:3000
-SHAPE_DOCS_PROJECT_CONFIGURATION_FILENAME=.shape-docs.yml
-NEXT_PUBLIC_SHAPE_DOCS_TITLE=Shape Docs
-NEXT_PUBLIC_SHAPE_DOCS_DESCRIPTION=Documentation for Shape's APIs
-NEXT_PUBLIC_SHAPE_DOCS_HELP_URL=https://github.com/shapehq/shape-docs/wiki
+FRAMNA_DOCS_BASE_URL=http://localhost:3000
+FRAMNA_DOCS_TITLE=Framna Docs
+FRAMNA_DOCS_DESCRIPTION=Documentation for Framna's APIs
+FRAMNA_DOCS_HELP_URL=https://github.com/shapehq/framna-docs/wiki
+FRAMNA_DOCS_PROJECT_CONFIGURATION_FILENAME=.shape-docs.yml
 NEXTAUTH_URL_INTERNAL=http://localhost:3000
 NEXTAUTH_SECRET=use [openssl rand -base64 32] to generate a 32 bytes value
 REDIS_URL=localhost
 POSTGRESQL_HOST=localhost
 POSTGRESQL_USER=dbuser
 POSTGRESQL_PASSWORD=
-POSTGRESQL_DB=shape-docs
+POSTGRESQL_DB=framna-docs
 REPOSITORY_NAME_SUFFIX=-openapi
 HIDDEN_REPOSITORIES=
 NEW_PROJECT_TEMPLATE_REPOSITORY=shapehq/starter-openapi

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -29,7 +29,7 @@ body:
     id: expected-behavior
     attributes:
       label: What is the expected behavior?
-      description: Please describe the behavior you expect of Shape Docs.
-      placeholder: I expect that Shape Docs would...
+      description: Please describe the behavior you expect of Framna Docs.
+      placeholder: I expect that Framna Docs would...
     validations:
       required: true

README.md

@@ -1,18 +1,18 @@
 <div align="center">
-<img width="200" src="https://github.com/shapehq/shape-docs/raw/main/logo.png" alt="Shape Docs logo" />
+<img width="200" src="https://github.com/shapehq/framna-docs/raw/main/logo.png" alt="Framna Docs logo" />
 </div>
 
 <div align="center">
-<h3>👋 Welcome to Shape Docs</h3>
+<h3>👋 Welcome to Framna Docs</h3>
 <h4>Self-hosted web portal that collects OpenAPI documentation and facilitates spec-driven development, built with GitHub-based authorization.</h4>
 </div>
 
 <div align="center">
-<a href="https://github.com/shapehq/shape-docs/actions/workflows/build.yml"><img src="https://github.com/shapehq/shape-docs/actions/workflows/build.yml/badge.svg"></a>
-<a href="https://github.com/shapehq/shape-docs/actions/workflows/run-unit-tests.yml"><img src="https://github.com/shapehq/shape-docs/actions/workflows/run-unit-tests.yml/badge.svg"></a>
-<a href="https://github.com/shapehq/shape-docs/actions/workflows/test-sql-queries.yml"><img src="https://github.com/shapehq/shape-docs/actions/workflows/test-sql-queries.yml/badge.svg"></a>
-<a href="https://github.com/shapehq/shape-docs/actions/workflows/lint.yml"><img src="https://github.com/shapehq/shape-docs/actions/workflows/lint.yml/badge.svg"></a>
-<a href="https://github.com/shapehq/shape-docs/actions/workflows/build-docker-image"><img src="https://github.com/shapehq/shape-docs/actions/workflows/build-docker-image.yml/badge.svg"></a>
+<a href="https://github.com/shapehq/framna-docs/actions/workflows/build.yml"><img src="https://github.com/shapehq/framna-docs/actions/workflows/build.yml/badge.svg"></a>
+<a href="https://github.com/shapehq/framna-docs/actions/workflows/run-unit-tests.yml"><img src="https://github.com/shapehq/framna-docs/actions/workflows/run-unit-tests.yml/badge.svg"></a>
+<a href="https://github.com/shapehq/framna-docs/actions/workflows/test-sql-queries.yml"><img src="https://github.com/shapehq/framna-docs/actions/workflows/test-sql-queries.yml/badge.svg"></a>
+<a href="https://github.com/shapehq/framna-docs/actions/workflows/lint.yml"><img src="https://github.com/shapehq/framna-docs/actions/workflows/lint.yml/badge.svg"></a>
+<a href="https://github.com/shapehq/framna-docs/actions/workflows/build-docker-image"><img src="https://github.com/shapehq/framna-docs/actions/workflows/build-docker-image.yml/badge.svg"></a>
 </div>
 
 ---
@@ -21,52 +21,69 @@
 <a href="#-getting-started">🚀 Getting Started</a>&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="#-how-does-it-work">👨‍🔧 How does it work?</a>&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="#-how-can-i-contribute">👩‍💻 How can I contribute?</a>&nbsp;&nbsp;&nbsp;&nbsp;
-<a href="https://github.com/shapehq/shape-docs/wiki">📖 Wiki</a>
+<a href="https://github.com/shapehq/framna-docs/wiki">📖 Wiki</a>
 </div>
 
 <hr />
 
-Shape Docs makes managing and previewing OpenAPI documentation a breeze, streamlining spec-driven development. With GitHub-based authorization, you can easily control who accesses your docs. Shape Docs comments on pull requests that tweak your OpenAPI specs, giving you preview URLs to ensure every update is well-reviewed.
+Framna Docs makes managing and previewing OpenAPI documentation a breeze, streamlining spec-driven development. With GitHub-based authorization, you can easily control who accesses your docs. Framna Docs comments on pull requests that tweak your OpenAPI specs, giving you preview URLs to ensure every update is well-reviewed.
 
 <div align="center">
-<img width="600" src="https://github.com/shapehq/shape-docs/raw/main/wiki/home.png?raw=true" alt="Screenshot of Shape Docs"/>
+<img width="600" src="https://github.com/shapehq/framna-docs/raw/main/wiki/home.png?raw=true" alt="Screenshot of Framna Docs"/>
 </div>
 
 ## 🚀 Getting Started
 
-Please refer to the following articles in [the wiki](https://github.com/shapehq/shape-docs/wiki) to get started with Shape Docs.
+Please refer to the following articles in [the wiki](https://github.com/shapehq/framna-docs/wiki) to get started with Framna Docs.
 
-- [Adding Documentation to Shape Docs](https://github.com/shapehq/shape-docs/wiki/Adding-Documentation-to-Shape-Docs)
-- [Browsing Documentation](https://github.com/shapehq/shape-docs/wiki/Browsing-Documentation)
-- [Updating Documentation](https://github.com/shapehq/shape-docs/wiki/Updating-Documentation)
-- [Deploying Shape Docs](https://github.com/shapehq/shape-docs/wiki/Deploying-Shape-Docs)
+- [Adding Documentation to Framna Docs](https://github.com/shapehq/framna-docs/wiki/Adding-Documentation-to-Framna-Docs)
+- [Browsing Documentation](https://github.com/shapehq/framna-docs/wiki/Browsing-Documentation)
+- [Updating Documentation](https://github.com/shapehq/framna-docs/wiki/Updating-Documentation)
+- [Deploying Framna Docs](https://github.com/shapehq/framna-docs/wiki/Deploying-Framna-Docs)
 
 ## 👨‍🔧 How does it work?
 
-Shape Docs uses [OpenAPI specifications](https://swagger.io) from GitHub repositories. Users log in with their GitHub account to access documentation for projects they have access to. A repository only needs an OpenAPI spec to be recognized by Shape Docs, but customization is possible with a .shape-docs.yml file. Here's an example:
+Framna Docs uses [OpenAPI specifications](https://swagger.io) from GitHub repositories. Users log in with their GitHub account to access documentation for projects they have access to. A repository only needs an OpenAPI spec to be recognized by Framna Docs, but customization is possible with a .framna-docs.yml file. Here's an example:
 
-<img width="650" src="https://github.com/shapehq/shape-docs/raw/main/wiki/example-openapi-repository-with-config.png?raw=true"/>
+<img width="650" src="https://github.com/shapehq/framna-docs/raw/main/wiki/example-openapi-repository-with-config.png?raw=true"/>
 
-Shape Docs supports spec-driven development by requiring OpenAPI specs in GitHub repos, ensuring version control and peer review. When a pull request is opened, Shape Docs comments with links to preview the documentation:
+Framna Docs supports spec-driven development by requiring OpenAPI specs in GitHub repos, ensuring version control and peer review. When a pull request is opened, Framna Docs comments with links to preview the documentation:
 
-<img width="760" src="https://github.com/shapehq/shape-docs/raw/main/wiki/pr-comment.png?raw=true"/>
+<img width="760" src="https://github.com/shapehq/framna-docs/raw/main/wiki/pr-comment.png?raw=true"/>
 
-Learn more from the [Adding Documentation](https://github.com/shapehq/shape-docs/wiki/Adding-Documentation-to-Shape-Docs), [Browsing Documentation](https://github.com/shapehq/shape-docs/wiki/Browsing-Documentation), and [Updating Documentation](https://github.com/shapehq/shape-docs/wiki/Updating-Documentation) articles in the wiki.
+Learn more from the [Adding Documentation](https://github.com/shapehq/framna-docs/wiki/Adding-Documentation-to-Framna-Docs), [Browsing Documentation](https://github.com/shapehq/framna-docs/wiki/Browsing-Documentation), and [Updating Documentation](https://github.com/shapehq/framna-docs/wiki/Updating-Documentation) articles in the wiki.
 
 ## 👩‍💻 How can I contribute?
 
-Pull requests with bugfixes and new features are much appreciated. We are happy to review PRs and merge them once they are ready, as long as they contain changes that fit within the vision of Shape Docs.
+Pull requests with bugfixes and new features are much appreciated. We are happy to review PRs and merge them once they are ready, as long as they contain changes that fit within the vision of Framna Docs.
 
-Clone the repository and consult the articles on [running Shape Docs locally](https://github.com/shapehq/shape-docs/wiki/Running-Shape-Docs-Locally) and [contributing](https://github.com/shapehq/shape-docs/wiki/Contributing) to get started contributing changes the project.
+Clone the repository and consult the articles on [running Framna Docs locally](https://github.com/shapehq/framna-docs/wiki/Running-Framna-Docs-Locally) and [contributing](https://github.com/shapehq/framna-docs/wiki/Contributing) to get started contributing changes the project.
 
 ```bash
-git clone git@github.com:shapehq/shape-docs.git
+git clone git@github.com:shapehq/framna-docs.git
 ```
 
+## 🔀 Git Workflow
+
+Two long-lived branches exist
+
+* **main** (stable/release - deploy to a **production** environment)
+* **develop** (integration - deploy to a **staging** environment)
+
+**Do's 👍**
+
+1. Features are branched off from `develop` and merged back in using a PR when ready. Rebase or merge `develop` in to keep the feature branch up to date. Squash merge the feature branch into `develop`.
+2. `develop` is merged into `main` whenever a new release is made. Only regular merge commits are allowed in this case. You do not need to "bring develop up to date" with `main` before merging.
+3. A hotfix is applied by branching out from `main`. The hotfix branch _must_ be merged into both `main` and `develop`.
+
+**Don'ts 🙅‍♂️**
+
+1. Never squash merge `develop` into `main` ☠️
+
 ## ❤️ The Product of a Shape Weekend
 
-Every year we go on Shape Weekend, three days where all employees in Shape get together for a hackathon to build amazing products. In 2023, a team of Shape developers with a passion for documentation and spec-driven development built Shape Docs and we've used it daily ever since!
+Every year we go on Shape Weekend, three days where all employees in Shape get together for a hackathon to build amazing products. In 2023, a team of Shape developers with a passion for documentation and spec-driven development built Framna Docs and we've used it daily ever since!
 
 ---
 
-Shape Docks is built with ❤️ by [Shape](https://shape.dk) in Denmark. Oh, and [we are hiring](https://careers.shape.dk) 🤗
+Framna Docs is built with ❤️ by [Shape](https://shape.dk) in Denmark. Oh, and [we are hiring](https://careers.shape.dk) 🤗

__test__/projects/updateWindowTitle.test.ts

@@ -1,19 +1,9 @@
 import { updateWindowTitle } from "@/features/projects/domain"
 
-test("It uses default title when there is no selection", async () => {
-  const store: { title: string } = { title: "" }
-  updateWindowTitle({
-    storage: store,
-    defaultTitle: "Demo Docs"
-  })
-  expect(store.title).toEqual("Demo Docs")
-})
-
 test("It leaves out specification when the specification has a generic name", async () => {
   const store: { title: string } = { title: "" }
   updateWindowTitle({
     storage: store,
-    defaultTitle: "Demo Docs",
     project: {
       id: "foo",
       name: "foo",
@@ -49,7 +39,6 @@ test("It leaves out version when it is the defualt version", async () => {
   const store: { title: string } = { title: "" }
   updateWindowTitle({
     storage: store,
-    defaultTitle: "Demo Docs",
     project: {
       id: "foo",
       name: "foo",
@@ -81,7 +70,6 @@ test("It adds version when it is not the defualt version", async () => {
   const store: { title: string } = { title: "" }
   updateWindowTitle({
     storage: store,
-    defaultTitle: "Demo Docs",
     project: {
       id: "foo",
       name: "foo",