Skip to content

Commit

Permalink
build: update content when upstream changes
Browse files Browse the repository at this point in the history
This commit adds support to update the content when there is a change
upstream by:

- Adding a webhook handler to redirect `push` and `release` events from
  `electron/electron` to this repo.
- Adding a GitHub action that responds to `repository_dispatch` events
  comming from the previous webhook.

More information can be found in #19

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Fix #19
  • Loading branch information
molant committed May 13, 2021
1 parent eda594a commit 1419b0e
Show file tree
Hide file tree
Showing 29 changed files with 3,864 additions and 76 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
GITHUB_TOKEN=
ORG=
24 changes: 24 additions & 0 deletions .github/workflows/update-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: 'Update docs'

on:
repository_dispatch:
types: [doc_changes]

jobs:
update-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '14'
- name: Install dependencies
run: 'yarn'
- name: Update pinned version
run: 'yarn update-pinned-version ${{ github.event.client_payload.sha }}'
- name: 'Prebuild'
run: 'yarn prebuild'
- name: 'Create PR'
run: 'yarn process-docs-changes'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
node_modules
.docusaurus
.DS_Store
.env
.vscode/settings.json
build/
content/
Expand Down
9 changes: 9 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
// See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp

// List of extensions which should be recommended for users of this workspace.
"recommendations": ["esbenp.prettier-vscode", "orta.vscode-jest"],
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
"unwantedRecommendations": []
}
43 changes: 43 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,43 @@
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"compounds": [
{
"name": "webhook local debugging",
"presentation": {
"hidden": false,
"group": "server",
"order": 1
},
"configurations": ["webhook", "smee"]
}
],
"configurations": [
{
"name": "webhook",
"presentation": {
"hidden": true
},
"program": "${workspaceFolder}/webhook/index.js",
"request": "launch",
"skipFiles": ["<node_internals>/**"],
"type": "pwa-node",
"cwd": "${workspaceFolder}/webhook/",
"console": "internalConsole"
},
{
"name": "smee",
"presentation": {
"hidden": true
},
"program": "${workspaceFolder}/webhook/node_modules/.bin/smee",
"request": "launch",
"skipFiles": ["<node_internals>/**"],
"type": "pwa-node",
"cwd": "${workspaceFolder}/webhook/",
"console": "internalConsole",
"args": ["--target", "${input:smee}"]
},
{
"type": "pwa-node",
"request": "launch",
Expand All @@ -22,5 +58,12 @@
"console": "integratedTerminal",
"cwd": "${workspaceFolder}/docs/how-to"
}
],
"inputs": [
{
"id": "smee",
"description": "The smee.io tunnel URL to your local environment",
"type": "promptString"
}
]
}
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,37 @@ yarn start

`yarn start` starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Build
# Repository content organization

```console
yarn build
This repository contains the code for 3 related things:

- The code to generate the contents of https://beta.electronjs.org
- [`create-electron-documentation`][ced] package
- The webhook that receives updates from `electron/electron` and
sends a `repository_dispatch` to trigger GitHub actions.

The content of this repository is organized as follows:

```
└─ root
|
├─ .github/workflows → The definitions for the GitHub actions
|
├─ webhook → The webhook server responsible of triggering
| GitHub actions
|
├─ create-electron-documentation → Code for the npm package
| of the same name. Read the readme in the folder
| for more information.
|
├─ scripts → The code for the package.json tasks and GitHub
| actions
|
├─ spec → Tests for the scripts
|
├─ src → Docusaurus code
|
├─ static → Docusaurus static assets
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
[ced]: https://npmjs.com/package/create-electron-documentation
195 changes: 195 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
/*
* For a detailed explanation regarding each configuration property, visit:
* https://jestjs.io/docs/en/configuration.html
*/

module.exports = {
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "/tmp/jest_rs",

// Automatically clear mock calls and instances between every test
clearMocks: true,

// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,

// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,

// The directory where Jest should output its coverage files
// coverageDirectory: undefined,

// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],

// Indicates which provider should be used to instrument code for coverage
coverageProvider: 'v8',

// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,

// A path to a custom dependency extractor
// dependencyExtractor: undefined,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,

// A set of global variables that need to be available in all test environments
// globals: {},

// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",

// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],

// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "json",
// "jsx",
// "ts",
// "tsx",
// "node"
// ],

// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
// moduleNameMapper: {},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
// preset: undefined,

// Run tests from one or more projects
// projects: undefined,

// Use this configuration option to add custom reporters to Jest
// reporters: undefined,

// Automatically reset mock state between every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: undefined,

// Automatically restore mock state between every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,

// A list of paths to directories that Jest should use to search for files in
// roots: [
// "<rootDir>"
// ],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],

silent: true,

// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing
testEnvironment: 'node',

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
// testMatch: [
// "**/__tests__/**/*.[jt]s?(x)",
// "**/?(*.)+(spec|test).[tj]s?(x)"
// ],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
// "/node_modules/"
// ],

testTimeout: 50000,

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
// testResultsProcessor: undefined,

// This option allows use of a custom test runner
// testRunner: "jasmine2",

// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
// testURL: "http://localhost",

// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
// timers: "real",

// A map from regular expressions to paths to transformers
// transform: undefined,

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
transformIgnorePatterns: ['/node_modules/', '.js$'],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: undefined,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
};
16 changes: 13 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,19 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"test": "prettier -c ./scripts/",
"prebuild": "node ./scripts/pre-build.js"
"lint": "prettier -c ./webhook/**/*.js ./scripts/**/*.js",
"test": "yarn lint && jest",
"prebuild": "node ./scripts/pre-build.js",
"process-docs-changes": "node ./scripts/process-docs-changes.js",
"update-pinned-version": "node ./scripts/update-pinned-version.js"
},
"dependencies": {
"@docusaurus/core": "^2.0.0-alpha.75",
"@docusaurus/preset-classic": "^2.0.0-alpha.75",
"@mdx-js/react": "^1.6.21",
"clsx": "^1.1.1",
"dotenv-safe": "^8.2.0",
"execa": "^5.0.0",
"react": "^17.0.1",
"react-dom": "^17.0.1"
},
Expand All @@ -36,17 +41,22 @@
]
},
"devDependencies": {
"@actions/core": "^1.2.7",
"@actions/github": "^4.0.0",
"@types/jest": "^26.0.23",
"@types/unist": "^2.0.3",
"del": "^6.0.0",
"fs-extra": "^9.1.0",
"globby": "^11.0.3",
"got": "^11.8.2",
"gunzip-maybe": "^1.4.2",
"jest": "^26.6.3",
"json5": "^2.2.0",
"latest-version": "^5.1.0",
"make-dir": "^3.1.0",
"prettier": "^2.2.1",
"tar-stream": "^2.2.0",
"unist-util-visit-parents": "^3.1.1"
}
},
"sha": "8d55658bfa8b5983e1a90ad079c2e2ac91ee7af0"
}
Loading

0 comments on commit 1419b0e

Please sign in to comment.