Summary:
With dotgit mode, users should be able to use the unmodified `ghstack` just fine.
There is no need for first party support for this 3rd party tool.
`ghstack` runs low-level Git commands that will not work if we migrate the `.sl/`
Git support to not use the Git on-disk format (for the benefit of laziness or
repack-free). There are already 3 different ways to `pr submit`, `ghstack` seems
just further adding confusion.
Reviewed By: sggutier
Differential Revision: D55970086
fbshipit-source-id: 85616f7f57b8bcebec0c83e326aecd4aaee090a7
Summary:
This diff adds a CFM rule to pull Sapling static docs content into the Sapling wiki.
If this fails, I'll delete this file and I'll clean up the wiki pages added.
[CFM Reference](https://www.internalfb.com/intern/wiki/CodeHub/Codehub_Flavored_Markdown/CFM_Publisher/)
Reviewed By: muirdm
Differential Revision: D54818016
fbshipit-source-id: 40c47ac47bb5ebad93a26338d34190d0321f8523
Summary:
The backtick was accidentally including the aside, now it only encompasses the command.
Pull Request resolved: https://github.com/facebook/sapling/pull/829
Reviewed By: quark-zju
Differential Revision: D53185153
fbshipit-source-id: af8c932101d612a07dd2fdbecf716d9b86f94107
Summary:
Previously, our minimum node version was 10. This is quite old.
We now use rollup to bundle our ISL server code. It seems rollup requires a minimum version of node that supports new ECMAscript features like `??` and `?.`. I Since node 10 and even 12 and 14 are no longer supported by node even for security updates, I think it's ok for us to drop support for this.
Reviewed By: sggutier
Differential Revision: D53976251
fbshipit-source-id: 3c5afabe79d86aced61e7027a81b2e3937b360f4
Summary:
doc: use `my-fork` consistently
Most of the documentation uses `my-fork` except for two files.
Update those two files for consistency.
Pull Request resolved: https://github.com/facebook/sapling/pull/702
Test Plan: CI
Reviewed By: Flameeyes, sggutier
Differential Revision: D50061369
Pulled By: genevievehelsel
fbshipit-source-id: 5c556a4b6136f750ff9d870c2c86a8a8713df931
Summary:
strager pointed out the URL has `%2B` in it (so curl writes the file with the
`%2B` name) and the file name below uses `+`. Use `-o` with the desired file
names to avoid issues.
Reviewed By: muirdm
Differential Revision: D45620202
fbshipit-source-id: 27c9247fada2b702888d9f888c8e80c9e3e29a8d
Summary:
Currently, `sl pr` is not default to `submit`, use `sl pr submit` directly.
```
$ sl pr
abort: you need to specify a subcommand (run with --help to see a list of subcommands)
```
Github issue:
* https://github.com/facebook/sapling/issues/525
Reviewed By: muirdm
Differential Revision: D43815868
fbshipit-source-id: 76076e5c7ecec40edf2e142a1c8387824e5a7b3a
Summary: Adds a page with release notes to the website
Reviewed By: muirdm
Differential Revision: D43757567
fbshipit-source-id: 28e26f38879d877b9c5d10d9e7179d35ce3970fe
Summary: [Currently our GitHub actions are failing](https://github.com/facebook/sapling/actions/runs/4319356092/jobs/7538439222) due to the `sl pr` command not being available as it is part of the GitHub extension. This enables the extension in `generate-command-markdown.py` for fixing the build
Reviewed By: bolinfest
Differential Revision: D43758711
fbshipit-source-id: 95fc5c0bfa07e5c304d3105ce8a398d8170d7cdd
Summary:
Some website claims that Sapling:
> Enforces a 1:1 relationship between commits and branches
It is not true. Add instructions about creating pull requests using `push`.
Reviewed By: zzl0
Differential Revision: D43749164
fbshipit-source-id: e1041331a39c6ed2f032bd37fa5a519290c1fc60
Summary:
Describe the current state of submodule support. Provide "howto"s for common
operations.
Reviewed By: zzl0
Differential Revision: D43724068
fbshipit-source-id: 6596ebdd8854e042f3b1b0e99e8dc089b6be09db
Summary:
While running "\build_windows_zip.py"
The python script is failing with error File Path too long so to fix the error we added git config -- true in the Windows build Instruction Documentation.
Reviewed By: sggutier
Differential Revision: D43408503
fbshipit-source-id: 892458db648befd2638f11ec4ae8d40f89d62bfc
Summary: A couple extra steps are needed to build on FreeBSD, so let's document those.
Reviewed By: quark-zju
Differential Revision: D43253311
fbshipit-source-id: d60bd794cdc7d51e4854837f42eba1c4ddea7246
Summary: The PR revset is hard to discover as it is. This adds some hints about its existence on the Sapling website.
Reviewed By: muirdm
Differential Revision: D42760527
fbshipit-source-id: 91177196c4e9dfd42e82ddde49e20684485b0711
Summary:
This removes the `ps>` prefix in the windows installation instructions. With `ps>` included, you can't directly copy and past the commands into powershell
Pull Request resolved: https://github.com/facebook/sapling/pull/454
Reviewed By: evangrayk
Differential Revision: D42594922
Pulled By: bolinfest
fbshipit-source-id: f798d9d74fdccfd088be9efb869857cfee8dead4
Summary:
I recently built and installed Sapling on a Windows machine
with few existing developer tools installed on it, so I wanted
to capture the `vcpkg` requirements that were not previously
documented.
Reviewed By: akushner
Differential Revision: D42232827
fbshipit-source-id: e6c9ce74b164b8f552188946a032852e06d03ec7
Summary:
Using the fix in D42230099, regenerate the command docs
for the website.
Pull Request resolved: https://github.com/facebook/sapling/pull/351
Test Plan:
Imported from OSS
Verify that `yarn build` works with the current `.md` file contents.
Reviewed By: zzl0
Differential Revision: D42230100
Pulled By: bolinfest
fbshipit-source-id: b9929bc1fdd4ede3dc032fdc310c4ca10e4a9194
Summary:
Note this fixes a broken link due to the `<Command>` change.
Fixes https://github.com/facebook/sapling/issues/335
Reviewed By: muirdm
Differential Revision: D42121142
fbshipit-source-id: 5a06757f1cc73c2b01cc9ddae1ed29bb9c9ea056
Summary:
As we are going to add more flags for `sl pr submit`, it no longer
works well to use `submit` as the default command. Though we
add `s` as an alias for `submit` so it does not require much typing.
Reviewed By: zzl0
Differential Revision: D42047829
fbshipit-source-id: 782339a44ec5b548b6fc5e61a32f8fb05c0c8fe4
Summary: Adds installation instructions for installing from Homebrew-core on macOS so that users don't have to manually download our bottle. It also adds one additional installation method for non-Ubuntu Linux users.
Reviewed By: bolinfest
Differential Revision: D42008426
fbshipit-source-id: 76757f43739bca3133e3265d5bbe6175edbc9f11
Summary:
This was requested for `sl pr` in
https://github.com/facebook/sapling/issues/218,
though this diff adds support for signing commits in general, in Sapling.
Here's how it works:
- `sl config --local gpg.key <KEY>` to specify your key
- Now `gitcommittext()` takes an optional `str` for the `gpgsigningkey` if `gpg.key` is set and `gpg.enabled` is `true` (which is the default).
- The text of the unsigned commit object is constructed and then signed using `gpg --status-fd=2 -bsau <KEY>` with the text passed via stdin.
- The resulting signature is embedded into the original text to sign it. Note that the original PGP key goes through some minor formatting (`\r` is removed; lines must start with a space to avoid a `\n\n` sequence) before it is embedded.
I documented things to the best of my knowledge in `eden/website/docs/git/signing.md`.
Follow-up items:
- Show signed status in smartlog?
- Update `sl ghstack` to honor signing configuration when running `git commit-tree`.
- Update `sl pr` to honor signing configuration when running `git commit-tree`.
Reviewed By: quark-zju
Differential Revision: D41778874
fbshipit-source-id: 5018a0d8bea1b5e9293c05954db65f35dd3c7aff
Summary:
When a user installs/browses the Sapling extension for VS Code,
they are presented with the `README.md`. Because this is likely
the user's entrypoint into the extension, this updates the README
with more guidance (and links) on how to get into the ISL experience.
Reviewed By: muirdm
Differential Revision: D41814194
fbshipit-source-id: 5c24d5e45655bde5db6287d1508e906b1c81e847
Summary:
Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/facebook/sapling/pull/294).
* __->__ https://github.com/facebook/sapling/issues/294
add Troubleshooting section for GitHub page
I just ran into an issue where `sl pr` failed to run because I
did not have `gh` configured as my Git credential helper.
It took me a bit of time to figure this out, so I thought I would
add it to the website, though the docs related to GitHub
integration are somewhat spread out, so I'm not sure whether this
is the best place for it. A dedicated Troubleshooting page might
be more appropriate, though such a page should probably have at
least two entries?
Though perhaps an even better solution is updating the code to
recognize this sort of failure and then suggest `gh auth setup-git`
directly when it happens.
Pull Request resolved: https://github.com/facebook/sapling/pull/294
Test Plan: http://localhost:3000/docs/git/intro
Reviewed By: akushner
Differential Revision: D41663482
Pulled By: bolinfest
fbshipit-source-id: ff957e298c143c62a2c05ea231eca8431011d106
Summary:
Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/facebook/sapling/pull/264).
* __->__ https://github.com/facebook/sapling/issues/264
[docs] add sl-shell-example syntax-highlighting language
Right now the example sl sessions have no hightlighting, or sometimes they pretend to be bash, which kind-of-half-works but also half doesn't work and is ugly (See the "Before" example - there is random highlighting for some numbers in the middle of command output, the ".." in "..." is randomly highlighted as a directory, etc)
This diff adds a new custom Prism language called "sl-shell-example" which does syntax highlighting specifically tailored for our example sessions with these main parts:
```
# comment
$ shell command
~/my/subdir $ shell command in a specific subdirectory
output
```
{F806536674}
(For the record, Prism already has a language called "shell-session", but that language doesn't support comments (which is something we make heavy use of), and also it tries to be clever by highlighting random words in the middle of shell commands (which is just distracting in the context of sapling docs))
Pull Request resolved: https://github.com/facebook/sapling/pull/264
Test Plan:
Before:
{F806536931}
After:
{F806537002}
Reviewed By: quark-zju
Differential Revision: D41522986
Pulled By: shish
fbshipit-source-id: fda9beb423a3c74d90c4cb387eb8cba3914a4693
Summary:
Get the windowsAsset version in the docs.
Pull Request resolved: https://github.com/facebook/sapling/pull/237
Reviewed By: bolinfest, zzl0
Differential Revision: D41476635
Pulled By: MichaelCuevas
fbshipit-source-id: 3769923de939a46b956bc7949a90af75a5989f0f
Summary:
Minor adjustments:
- Fixes mistakes I made in those docs.
- Fix/add links.
- Clarify some differences with hg.
Reviewed By: muirdm
Differential Revision: D41393733
fbshipit-source-id: 726ee783723d0fa5b4c60376487ed93de3a520ab
