3 Getting Started
Getting started using Forge should be fairly easy, but there are a few
caveats you should be aware of:
- Forge uses the Ghub package to access forge APIs. That package
comes with a setup wizard that should make it easy to create and
store a Github API token. Unfortunately the same cannot be done for
other forges and in the past it has failed for some users for Github
too, in particular when using two-factor authentication. See Token Creation for more information.
- Fetched information is stored in a database. The table schemata of
that database have not been finalized yet. Until that has happened
it will occasionally have to be discard. That isn’t such a huge
deal because for now the database does not contain any information
that cannot simply be fetched again, see Initial Pull.
- Fetching is implemented under the assumption that the API can be
asked to list the things that have changed since we last checked.
Unfortunately the APIs are not bug-free, so this is not always the
case. Issues such as https://platform.github.community/t/7284 can
take years to get addresses (in closed-source software), so I am no
longer delaying the initial Forge release because of that. If in
doubt, then re-fetch an individual pull-request to ensure it is
up-to-date using the command
forge-pull-pullreq
.
- Some other, forge-specific, caveats are mentioned in Supported Forges and Hosts.