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.

Sign up for GitHub

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

update GitHub pages #59

Merged
merged 2 commits into from
Jul 10, 2024
Merged

update GitHub pages #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d51d222
add workflow
gennadigennadigennadi Jul 10, 2024
b535012
update index.md
gennadigennadigennadi Jul 10, 2024
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
6 changes: 4 additions & 2 deletions build-deptrac.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@ info "Dump Composer Autoloader"
$PHP /usr/bin/composer dump-autoload --working-dir $BUILD_TMP -a --no-dev

info "Copy package templates"
cp -R $BUILD_DIR/template/* *.md mkdocs.yml docs -t $BUILD_TMP
cp -r $BUILD_DIR/template/* *.md mkdocs.yml docs -t $BUILD_TMP
cp -r $BUILD_DIR/template/.* -t $BUILD_TMP

info "Copy build into deptrac distrubtion repository"
cp -a $BUILD_TMP/. $DEPTRAC_DIR
cp -r $BUILD_TMP/* $DEPTRAC_DIR
cp -rv $BUILD_TMP/.* $DEPTRAC_DIR

# info "Git commit changes"
# echo "Update $(date)" > git_commit_message.txt
Expand Down
21 changes: 21 additions & 0 deletions build/template/.github/workflows/build-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Build and deploy documentation
on:
release:
types: [published]
workflow_dispatch: ~

jobs:
build-documentation:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
architecture: 'x64'
- name: Install dependencies
run: python -m pip install --upgrade pip mkdocs mkdocs-material
- name: Deploy documentation
run: mkdocs gh-deploy --force
16 changes: 4 additions & 12 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,16 @@ You can analyse projects that require an older PHP version as long as

## Installation

You can install Deptrac via Composer. We recommend using the [deptrac-shim](https://github.com/qossmic/deptrac-shim) package for this.
You can install Deptrac via Composer. We recommend using the [deptrac](https://github.com/qossmic/deptrac) package for this.
Alternatively, you can also use [PHIVE](#phive) or download the
[PHAR](#phar) attached to each release on GitHub.
This will ensure that Deptrac and its dependencies are
bundled together and will not interfere with any of your project's dependencies.

### Composer

We strongly advise against using the deptrac package directly as a composer dependency.
We update dependencies regularly, which might cause disruptions in your project.
Instead, please use the dedicated distribution repository <https://github.com/qossmic/deptrac-shim>.

When you install Deptrac using the qossmic/deptrac-shim package, you will get
the benefit of using the phar installation, but you can use it like any other
composer dependency, i.e. you run Deptrac like this:

```console
$ composer require --dev qossmic/deptrac-shim
$ composer require --dev qossmic/deptrac
vendor/bin/deptrac analyse
```

Expand All @@ -61,7 +53,7 @@ Feel free to add Deptrac to your PATH (i.e. `/usr/local/bin/deptrac`) to make it
globally available.

```console
$ curl -LS https://github.com/qossmic/deptrac/releases/download/1.0.2/deptrac.phar -o deptrac.phar
$ curl -LS https://github.com/qossmic/deptrac/releases/download/2.0.1/deptrac.phar -o deptrac.phar

# optional
$ sudo chmod +x deptrac.phar
Expand All @@ -75,7 +67,7 @@ You can install Deptrac with [Phive](https://phar.io/#Install)
`phive install -g qossmic/deptrac`

and accept the key with fingerprint
`41DD E075 4745 9FAE CFA1 7813 B8F6 4013 4AB1 782E`.
`57CB 556F 242F C8D4 FD48 3C2C 4743 6587 D82C 4A39`.

To upgrade Deptrac use the following command:

Expand Down
Loading