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

Jump to bottom

Rename Scala CLI template to example #3917

Merged
merged 2 commits into from
Mar 7, 2024
Merged

Rename Scala CLI template to example #3917

merged 2 commits into from
Mar 7, 2024

Conversation

jackkoenig
Copy link
Contributor

This avoids name aliasing with the chisel-template repository.

As part of this, I will manually add chisel-example.scala to existing releases that currently have chisel-template.scala

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash

Release Notes

Existing links to https://github.com/chipsalliance/chisel/releases/latest/download/chisel-template.scala should instead use https://github.com/chipsalliance/chisel/releases/latest/download/chisel-example.scala

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig
Rename Scala CLI template to example
fe61682 
This avoids name aliasing with the chisel-template repository.
@jackkoenig jackkoenig added the Documentation Only changing documentation label Mar 7, 2024
@jackkoenig jackkoenig added this to the 3.6.x milestone Mar 7, 2024
seldridge
seldridge approved these changes Mar 7, 2024
View reviewed changes
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

LGTM

.github/workflows/scala-cli-example.yml Outdated Show resolved Hide resolved
@jackkoenig @seldridge
Update .github/workflows/scala-cli-example.yml
b243cee 
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
@jackkoenig jackkoenig enabled auto-merge (squash) March 7, 2024 22:49
@jackkoenig jackkoenig merged commit bb3c640 into main Mar 7, 2024
14 checks passed
@jackkoenig jackkoenig deleted the chisel-scala-cli-example branch March 7, 2024 23:01
@mergify mergify bot added the Backported This PR has been backported label Mar 7, 2024
mergify bot pushed a commit that referenced this pull request Mar 7, 2024
@jackkoenig @mergify
Rename Scala CLI template to example (#3917)
a8e71f5 
This avoids name aliasing with the chisel-template repository.

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
(cherry picked from commit bb3c640)

# Conflicts:
#	.github/workflows/build-scala-cli-example.yml
#	.github/workflows/build-scala-cli-example/action.yml
#	.github/workflows/build-scala-cli-example/chisel-example.scala
#	.github/workflows/scala-cli-template.yml
#	.github/workflows/test.yml
#	docs/src/installation.md
@mergify mergify bot mentioned this pull request Mar 7, 2024
Merged
14 tasks
mergify bot pushed a commit that referenced this pull request Mar 7, 2024
@jackkoenig @mergify
Rename Scala CLI template to example (#3917)
a649f55 
This avoids name aliasing with the chisel-template repository.

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
(cherry picked from commit bb3c640)

# Conflicts:
#	.github/workflows/build-scala-cli-example.yml
#	.github/workflows/build-scala-cli-example/action.yml
#	.github/workflows/build-scala-cli-example/chisel-example.scala
#	.github/workflows/scala-cli-template.yml
#	.github/workflows/test.yml
#	docs/src/installation.md
@mergify mergify bot mentioned this pull request Mar 7, 2024
Merged
14 tasks
mergify bot pushed a commit that referenced this pull request Mar 7, 2024
@jackkoenig @mergify
Rename Scala CLI template to example (#3917)
0106854 
This avoids name aliasing with the chisel-template repository.

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
(cherry picked from commit bb3c640)

# Conflicts:
#	docs/src/installation.md
@mergify mergify bot mentioned this pull request Mar 7, 2024
Merged
14 tasks
chiselbot pushed a commit that referenced this pull request Mar 7, 2024
@mergify @jackkoenig
Rename Scala CLI template to example (backport #3917) (#3920)
e884e07 
* Rename Scala CLI template to example (#3917)

This avoids name aliasing with the chisel-template repository.

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
(cherry picked from commit bb3c640)

# Conflicts:
#	docs/src/installation.md

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
chiselbot pushed a commit that referenced this pull request Mar 7, 2024
@mergify @jackkoenig
Rename Scala CLI template to example (backport #3917) (#3919)
b4efc58 
* Rename Scala CLI template to example (#3917)

This avoids name aliasing with the chisel-template repository.

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
(cherry picked from commit bb3c640)

# Conflicts:
#	.github/workflows/build-scala-cli-example.yml
#	.github/workflows/build-scala-cli-example/action.yml
#	.github/workflows/build-scala-cli-example/chisel-example.scala
#	.github/workflows/scala-cli-template.yml
#	.github/workflows/test.yml
#	docs/src/installation.md

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
chiselbot pushed a commit that referenced this pull request Mar 7, 2024
@mergify @jackkoenig
Rename Scala CLI template to example (backport #3917) (#3918)
60ebc65 
* Rename Scala CLI template to example (#3917)

This avoids name aliasing with the chisel-template repository.

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
(cherry picked from commit bb3c640)

# Conflicts:
#	.github/workflows/build-scala-cli-example.yml
#	.github/workflows/build-scala-cli-example/action.yml
#	.github/workflows/build-scala-cli-example/chisel-example.scala
#	.github/workflows/scala-cli-template.yml
#	.github/workflows/test.yml
#	docs/src/installation.md

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seldridge seldridge seldridge approved these changes

Assignees
No one assigned
Labels
Backported This PR has been backported Documentation Only changing documentation
Projects
None yet
Milestone
3.6.x
Development

Successfully merging this pull request may close these issues.
2 participants
@jackkoenig @seldridge