Skip to content

Commit 037127e

Browse files
committed
chore: Added semantic release.
1 parent 0f63fc3 commit 037127e

File tree

5 files changed

+5790
-162
lines changed

5 files changed

+5790
-162
lines changed

.github/workflows/release.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
2+
# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
3+
4+
name: Release
5+
6+
on:
7+
push:
8+
branches:
9+
- main
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
env:
15+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
16+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 20
22+
registry-url: https://registry.npmjs.org/
23+
- name: Build dist
24+
run: npm build
25+
- name: Release to NPM
26+
run: npx semantic-release

README.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,17 @@
1-
# Astro Starter Kit: Minimal
1+
# Patternfly Documentation Core
22

3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
3+
Patternfly documentation core contains the base packages needed to build and release the PatternFly org website.
64

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
5+
## Development
106

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
7+
The website is built using [Astro](https://astro.build). Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
128

13-
## 🚀 Project Structure
14-
15-
Inside of your Astro project, you'll see the following folders and files:
16-
17-
```text
18-
/
19-
├── public/
20-
├── src/
21-
│ └── pages/
22-
│ └── index.astro
23-
└── package.json
24-
```
25-
26-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
27-
28-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
9+
The `src/components/` folder contains Astro and React components that can be used to build the websites pages.
2910

3011
Any static assets, like images, can be placed in the `public/` directory.
3112

13+
To define the markdown schema this project uses a typescript based schema known as [Zod](https://zod.dev). Details of how this is integratred into Astro can be found in Astros documentation on [content creation using Zod](https://docs.astro.build/en/guides/content-collections/#defining-datatypes-with-zod).
14+
3215
## 🧞 Commands
3316

3417
All commands are run from the root of the project, from a terminal:
@@ -41,7 +24,3 @@ All commands are run from the root of the project, from a terminal:
4124
| `npm run preview` | Preview your build locally, before deploying |
4225
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
4326
| `npm run astro -- --help` | Get help using the Astro CLI |
44-
45-
## 👀 Want to learn more?
46-
47-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).

0 commit comments

Comments
 (0)