Getting Started with CodeScene when Your Repositories Are in GitHub

Table of Contents

• CodeScene Explained
• Stakeholders
• Installation
• Configuration
• Adding Repositories
• Q&A

What is CodeScene?

CodeScene is an intelligent code analysis tool that helps teams improve code quality, reduce technical debt, and enhance development workflows. By integrating CodeScene with GitHub, teams can automatically analyze repositories, identify hotspots, and gain valuable insights to support decision-making.

Who Benefits From CodeScene with Azure DevOps?

Stakeholders:

• Developers: Get insights into problematic code areas, refactoring recommendations, and team collaboration metrics.

• Engineering Managers: Monitor code health, track risks, and ensure engineering efforts align with business goals.

• CTOs & Tech Leads: Use data-driven analysis to optimize project roadmaps, reduce technical debt, and understand team dynamics.

• DevOps Teams: Integrate CodeScene into GitHub Actions, enabling automated code reviews as part of CI/CD workflows.

How to Enable CodeScene for GitHub

Install CodeScene

Run CodeScene in Docker 

Once the container is running, access CodeScene at http://localhost:3003 for a local installation or at the server's url and log in with your license credentials.

• Standalone Installation:
  Ensure Java 17+, Git, and SSH are installed. Run CodeScene as: 

  java -jar codescene.standalone.jar

  Access it via http://localhost:3003 for a local installation or at the server's url.

Authenticate CodeScene with GitHub

• CodeScene needs access to your repositories in GitHub. Choose one of the following methods:

Option A: Authenticate Using a Personal Access Token (PAT)

1. Go to GitHub → Settings → Developer Settings → Personal Access Tokens.

2. Generate a new PAT with repo (read access) and admin:public_key permissions.

3. Use this PAT in CodeScene when specifying remote repositories.

Option B: Authenticate Using SSH Keys (Recommended for Security)

1. Generate an SSH key inside the CodeScene container:

   docker exec -it -u codescene codescene ssh-keygen -q -t ed25519 -N '' -C "codescene" -f "/codescene/.ssh/id_ed25519"

2. Retrieve the public key:

   docker exec -it -u codescene codescene ssh-keygen -y -t ed25519 -f "/codescene/.ssh/id_ed25519"

3. Add the Public Key to GitHub:

   • Navigate to GitHub → Settings → SSH & GPG Keys → New SSH Key.

   • Paste the generated key.

4. Validate Access:

   docker exec -it -u codescene codescene ssh -T git@github.com

Add GitHub Repositories to CodeScene:

• In CodeScene, create a new project.

• Choose Specify Remotes and enter your GitHub repository URL in SSH format:

  git@github.com:your-org/your-repo.git

• CodeScene will automatically clone and analyze your GitHub repository. 

Frequently Asked Questions