Skip to content

Commit

Permalink
Updates from the release
Browse files Browse the repository at this point in the history
  • Loading branch information
panglesd committed Sep 14, 2024
1 parent a8b230a commit 3d01736
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 16 deletions.
30 changes: 20 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@

In order to release a new version, you need to:

- Check that the changelog is up to date
### Check that the changelog is up to date

- Have an up to date engine, both in the `dist` (?) folder and in the ocaml data files:
Do that!

### Have an up to date engine, both in the `dist` (?) folder and in the ocaml data files:

```
$ make bundle
```

- Have an up to date compiler written in javascript, in release mode:
This is likely to be updated to something less cumbersome

### Have an up to date compiler written in javascript, in release mode:

```
$ dune build
Expand All @@ -23,25 +27,31 @@ $ cat _build/default/compiler/src/bin/main_js.bc.js >> bin/slipshow
$ chmod a+x bin/slipshow
```

- Do the npm release
### Do the npm release

```
$ npm version patch # Or minor or major, let's dream!
$ npm publish # Publishing
```

- Do the github release
### Do the github release

```
$ git push
$ # and push tags!
```

- Do the opam release
### Do the opam release

Use `dune-release`
Use `dune-release`:
- Checkout the branch which has the tag
- Call `dune-release distrib`
- Call `dune-release publish distrib`
- Call `dune-release opam pkg`
- Call `dune-release opam submit`
- Verify that everything is right by comparing the `opam` file for the previous version, with this one!

- Make a slipshow-gui release
### Make a slipshow-gui release

`dune install` the last release of slipshow.

Expand All @@ -55,7 +65,7 @@ sliphub$ npm run tauri dev # To test

Git commit and push. This will create a draft release. Finish it and undraft it.

- Make a slipshow-vscode release
### Make a slipshow-vscode release

Publish on vscode official repo

Expand All @@ -67,4 +77,4 @@ slipshow-vscode$ vsce publish patch # (or minor, major)

Publish on open-vsx: connect to open-vsx, login and manually publish the new vsix.

- Update sliphub
### Update sliphub
12 changes: 6 additions & 6 deletions dune-project
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
(package
(name slipshow)
(synopsis "A compiler from markdown to slipshow")
(description "A longer description")
(description "Slipshow is an engine to write slips, a concept evolved from slides.")
(depends
ocaml
(ocaml (>= 4.14))
dune
(crunch :with-dev-setup)
cmdliner
Expand All @@ -33,14 +33,14 @@
js_of_ocaml-compiler
js_of_ocaml-lwt
magic-mime
dream
(dream (>= "1.0.0~alpha5"))
fpath
brr
ppx_blob
(brr (>= "0.0.6"))
(ppx_blob (>= "0.8.0"))
(odoc :with-doc)
(ocamlformat
(and :with-dev-setup (= 0.26.2))))
(tags
(slipsow presentation slideshow beamer)))
(slipshow presentation slideshow beamer)))

; See the complete stanza docs at https://dune.readthedocs.io/en/stable/dune-files.html#dune-project

0 comments on commit 3d01736

Please sign in to comment.