README
Orta edited this page 2021-08-02 17:04:39 +01:00
Clone

Wiki Page Revisions

9 Commits

Author SHA1 Message Date
Orta
ae48ed676b Master -> main 2021-08-02 17:04:39 +01:00
Eli Barzilay
f41854c618 Comment the script, fix README 2021-05-24 19:30:01 -04:00
Eli Barzilay
30eae48773 Implement a two-way mirroring between the wiki and its public repo
Previously, changes to the wiki would get merged to the public repo in a
once-a-week action.  This significantly revises this, making the two
sides be mirrors (up to the few seconds it takes to do a merge).

This is driven by a minimal-ish yaml file in both sides (`TypeScript`
and `TypeScript-wiki`) that *always* works from the script in the public
repo.

The two action specs are nearly identical, but there are some differences:

  - On the main repo, trigger on a `gollum` event, and in the wiki repo
    the usual (pushes, schedule, manual).  (The schedule run is kept as
    a just-in-case, and it's now running twice a week.)
  - The filename is `sync-wiki` on the TS side and just `sync` in the
    wiki.  (Good to avoid confusion if both files somehow find
    themselves in the same neighborhood.)
  - The secret names are different since I used the name that already
    exists in each side.

The script does *not* start with a checkout of its repository.  Doing
this in the TS side would be redundant (it would get the TS tree) and
slow.  Instead, it's always cloning the public wiki repo (`DASHREMOTE`,
since its url is `.../TypeScript-wiki`) and then fetching into it the
repo of the rendered wiki (`DOTREMOTE`, with a `.../TypeScript.wiki`)
url.

Also revised the README, since they should always be mirrored with this
change, and therefore there is no "source of truth".
2021-05-24 16:14:51 -04:00
Pedro Augusto de Paula Barbosa
8aafa7834c
Fix broken link in readme 2020-02-18 12:54:43 -03:00
Orta Therox
6e95591f70 Update the README 2019-12-16 16:24:46 +00:00
Orta Therox
61446a8e81 Add docs to run it locally 2019-12-15 11:17:52 +00:00
Orta Therox
e6332a972e Start migrating my tsc notes to the wiki 2019-12-10 18:00:41 -05:00
Orta Therox
eb37cd64cf Some README tweaks 2019-11-13 12:21:13 -05:00
Orta Therox
6f4df4ba1a Adds a README and license 2019-11-13 12:16:53 -05:00