Skip to content

Commit 18feabf

Browse files
docs: integrate configuration in GitHub actions (#227)
Signed-off-by: David Dal Busco <[email protected]>
1 parent cc3f62b commit 18feabf

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

docs/guides/github-actions.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ sidebar_position: 8
77

88
# GitHub Actions
99

10-
Using any features offered by the Juno [CLI] within GitHub Actions is possible.
10+
You can leverage the Juno [CLI] to perform tasks within GitHub Actions.
1111

12-
---
13-
14-
## Using GitHub Actions to Deploy Your Decentralized App
12+
This guide will show you how to set up and deploy your decentralized app to Juno satellites using the action [junobuild/juno-action](https://github.com/junobuild/juno-action).
1513

16-
This guide will walk you through deploying your decentralized app to Juno satellites using the [junobuild/juno-action](https://github.com/junobuild/juno-action) GitHub Action.
14+
---
1715

18-
### Adding a Secret Token for Automation
16+
## 1. Add a Secret Token for Automation
1917

2018
Before you can effectively implement automation, it is necessary to add a secret token to your GitHub repository or organization. This token will enable the CI (Continuous Integration) to deploy to your [satellite].
2119

@@ -35,7 +33,35 @@ While you can generate a controller with administrative permission, we strongly
3533

3634
:::
3735

38-
### Creating the GitHub Action
36+
---
37+
38+
## 2. Configure your project
39+
40+
If you already have a `juno.config` file at the root of your project, you can skip to the next chapter. Otherwise, you need to create one. The configuration file can be a TypeScript, JavaScript, or JSON file (`juno.config.ts`, `juno.config.js|.mjs`, or `juno.config.json`), depending on your preference.
41+
42+
At a minimum, the configuration file must include the following:
43+
44+
- **Satellite ID**: A unique identifier for your satellite.
45+
- **Source**: The directory containing the built assets for your satellite. This is typically the output folder of your build process (e.g., `/dist` or `/build`), generated after running a command like `npm run build`.
46+
47+
Here’s an example configuration file:
48+
49+
```javascript
50+
import { defineConfig } from "@junobuild/config";
51+
52+
export default defineConfig({
53+
satellite: {
54+
id: "qsgjb-riaaa-aaaaa-aaaga-cai", // Replace with your satellite ID
55+
source: "build" // Replace with your build output directory
56+
}
57+
});
58+
```
59+
60+
For detailed information about all available configuration options, refer to the [configuration](../miscellaneous/configuration.mdx) section.
61+
62+
---
63+
64+
## 3. Create the GitHub Action
3965

4066
To configure the action, follow these steps:
4167

0 commit comments

Comments
 (0)