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

chore: add troubleshooting #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
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
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,42 @@ You need to set some variables in order to be able to use clever-tools in GitLab
The rest of variables in this script are implicit in GitLab.

More info can be found in [GitLab's doc](https://docs.gitlab.com/ee/topics/build_your_application.html)

## Troubleshooting

### Shallow repository

If you encounter the error

> Failed to push your source code because your repository is shallow and therefore cannot be pushed to the Clever Cloud remote

This means, GitLab make a [shallow clone](https://git-scm.com/docs/shallow) of the repository for the CI.
This basically means the repository has an incomplete history.

By default, GitLab uses a limited shallow clone as referenced here: <https://gitlab.com/gitlab-org/gitlab/-/issues/350100>

Solution is to make sure one has a full copy of the repository.
To do so, in GitLab, go to `Settings` > `CI/CD` > `General pipelines` and scroll to the `Git strategy` section.
There either choose `git clone` to have a full clone of the repository or use `git fetch` but set `Git shallow clone` to `0` to make sure you get the full history

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @dgoosens, thanks for the PR!

I've opted to add to the scripts the following line:

variables:
 GIT_DEPTH: 0

This prevents the error and avoids getting the user too much into GitLab documentation, to get started and running asap.

### Application not found

If, when running the commmand

```bash
clever link ${APP_ID}
```

You get the message

```bash
[ERROR] Application not found
```

This may mean you need to specify the organization aswell

```bash
clever link ${APP_ID} --org ${ORG_ID}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you encountered this error? Because it arises when you try to link using the alias, but not with the app_id which is linked to the organisation by default.

````

**Note**: The `ORG_ID`, or Organization ID, can be found in the upper right corner of your Clever Cloud Console