Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fork install option #671

Merged
merged 2 commits into from
Jul 10, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/develop/getting-started/instance-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,24 @@ invenio-cli run
invenio-cli services destroy
invenio-cli services setup

In some cases you might want to include a forked package in your InvenioRDM
tmorrell marked this conversation as resolved.
Show resolved Hide resolved
instance permanently. For example, you might have a local identifier scheme that
you want [idutils](https://github.com/inveniosoftware/idutils)
to verify. It wouldn't be appropriate to make a pull request, since this
change is only relevant to your organization. You can make your fork available on GitHub
and add the following to your Pipfile
tmorrell marked this conversation as resolved.
Show resolved Hide resolved

```
[packages]
idutils = {git = "https://github.com/your-username/idutils.git", ref = "main"}
```

You may need to delete your Pipfile.lock and run `invenio-cli install` the first time you make this change.
tmorrell marked this conversation as resolved.
Show resolved Hide resolved

!!! warning
It's not recommended to do this with invenio packages that change often,
since it will be difficult to keep your fork up to date.
tmorrell marked this conversation as resolved.
Show resolved Hide resolved

**Edit CSS and JavaScript included in Python modules**

Some Python modules includes CSS/JavaScript which is usually located in
Expand Down
Loading