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

Unnecessary .github folder and missing dependabot implementation when using gitlab as repository host #454

Open
mbwinkler opened this issue Jul 16, 2024 · 3 comments

Comments

@mbwinkler
Copy link

Currently, creating a project from the template with a repository target hosted on gitlab results in an unnecessary .github folder and no dependabot implementation in .gitlab-ci.yml.

This could be fixed with the following logic:

  1. Always create all necessary CI/CD files for both gitlab & github on generation
  2. Remove unnecessary files/folders using a post-generation hook

This hook would be stored in hooks/post_gen_project.py and would look something like this

import os
import shutil

# Determine the target platform
target_platform = '{{ cookiecutter.__ci }}'

# Define paths to CI directories
github_ci_path = os.path.join(os.getcwd(), '.github')
gitlab_ci_file = os.path.join(os.getcwd(), '.gitlab-ci.yml')
gitlab_dependabot_file = os.path.join(os.getcwd(), 'dependabot.yml')

if target_platform == 'github':
    # Remove the GitLab CI file if the target is GitHub
    if os.path.exists(gitlab_ci_file):
        os.remove(gitlab_ci_file)
        os.remove(gitlab_dependabot_file)
elif target_platform == 'gitlab':
    # Remove the GitHub Actions directory if the target is GitLab
    if os.path.exists(github_ci_path):
        shutil.rmtree(github_ci_path)
@henryiii
Copy link
Collaborator

And for copier? I believe I didn't do this because I was avoiding any custom hooks (we used to have several for things now handled via the template engine). But maybe it would be a good idea to use them for this.

What is dependabot supposed to look like for gitlab?

@mbwinkler
Copy link
Author

I am not sure about copier.

Dependabot-gitlab is implemented pretty much the same way Dependabot is on Github.

Add the .gitlab/dependabot.yml with the following basic contents:

version: 2
updates:
  - package-ecosystem: package-manager
    directory: /
    schedule:
      interval: daily

More information on the setup here.

@henryiii
Copy link
Collaborator

Can .gitlab-ci.yml go in .gitlab?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants