pharo-vcs / iceberg

Iceberg is the main toolset for handling VCS in Pharo.

Iceberg

Iceberg is the main toolset for handling VCS in Pharo.

More concretely, Iceberg provides tools to checkout, commit, merge and other common operations in git repositories, all directly from the image. In fact, git is currently the only VCS backend for Iceberg, but it's design supports the addition of other options.

Iceberg also provides some plugins for smooth and fast integration with common actions in the workflow of contributors, such as creating a branch based on a GitHub issue number.

Getting Started

Newcomer as User? Follow this 5 minutes tutorial.

Newcomer as Contributor? Read this guide.

Want to Chat? There is the #iceberg channel in the Pharo Discord server.

You can find more useful information in our Wiki section.

License

The code is licensed under the MIT license.

iceberg's Issues

Validate that an existing repository is compatible when creating another one in the same location.

If I create a local repo in a preexisting location, I should validate that the previous repo

• has the same origin
• has the same directory structure

Test Iceberg repositoryForPackage with an existent IceMCRepository

It should create an Ice repository for the existing MCRepo.

In fact, maybe the IceRepo should already exist, so it does not make sense to create a new one.

Show changes to class definitions in the IceChangesTreeView

IceClassChangeSet has the information but is not being shown in the UI.

When creating a repository, should we add it to the MCRepositoryGroup registry?

Use a special icon for extension methods.

Removed classes are not shown in changes tree.

After creating a branch, push does not work

The first push to a locally created branch requires to set the upstream. We could default to upstream to the same branch or we could ask the user to make a decision.

Create tests for the changes model

This is a lot of work.

We are not saving commit messages

Ice packageNamed: should return an RPackage instead of an MCPackage

And be coordinated with packageNamed:ifAbsent:

Merge a branch into another one.

Maybe create a tool for branch management.

Show diff in push browser

Allow to move an image file

Local git repos in iceberg-cache should keep being valid, either because they have been moved with the image or because we re-create the local clones from their remote counterparts.

Other git repos (with absolute file locations) will be expected to be in the same place, regardless of the image being moved.

Improve repository handling

1. Add a repository registry, assign names to repositories.
2. Allow to decide location of repositories, and detect pre-existing clones.
3. ¿Provide a view to select repositories?
4. Allow to set subdirectory and take advantage of gitfiletree posibilities.

Update mechanism

Should allow to update the tool to the latest version:
Iceberg update

or to a specific version

Iceberg update: '0.0.2'
Iceberg update: #stable
Iceberg update: #bleedingEdge

Allow to browse existing ice repositories

Ensure that all possible modifications to code are supported

We might look at the hierarchy of MCDefinition for a guide to completeness.

Add shortcut to commit button

What to do with "tag" creation/deletion

When you create a new tag inside a package, an MCDefinitionOperation is created, but with current formats it does not make sense to save it in github as this information is only contained inside classes.

If we require to ensure that a tag persists even without classes, we should change the file/tree format.

Graphical interface for creating a new repository.

Create an IceRepository registry

Ignore unloaded packages.

Unloaded packages should not be shown in the changes tree (or note that they are unloaded).
Also they should not be taken into account when commited.

If I do not indicate a branch and the repository already exists, it should point to the previously checked out branch.

Rename packages and repository

This is because we create the tree looking at the packages that are already in the repository.

Refresh tree after commit.

Or also manually.

GUI for adding existing an existing package to an ice repository

Classes in changes tree should be sorted alphabeticaly.

Create a unique commit for the whole repository

Instead of one per package.

Test subdirectory feature.

I am not sure that it is working.

Do not allow to commit with an empty message.

Add names to ice repositories

Every created repository is remembered, so if you execute again IceRepository origin: '[email protected]:npasserini/pharo-git.git' you will get the same repository again.

Also, each repository has a name that can be a simpler way to get access to it.
The default name is the same as the name of the github repository, so you can regain access to the recently created repository by evaluating: IceRepository named: 'pharo-git'.

You can change the default name by doing: myRepo name: 'default'.

Conflicts creating a repository after changing branches.

We can reproduce it by changing pharo-git branch, and starting IceExamples exampleSynchronizer

exampleSynchronizer
    | repository changeSet |
    repository := Git new origin: '[email protected]:npasserini/pharo-git.git'.
    changeSet := IceRepositoryChangeSet fromRepository: repository.
    IceSynchronizer new
        changeSet: changeSet;
        openWithSpec.

I do not think it is a problem of the example, can happen in production code.
We should decide if we take the branch from the (pre)existing directory, use another directory or something smarter. Maybe we could let the user decide in each case.

On the other hand, if we removed the working copies from disk, this error would never happen.

IceRepository>>loadPackage: should receive a package and not a name.

Select synchronizer tab according to repository state

And choose which options to enable in each case.

Metacello does not produce a meaningful error when trying to download an inexistent branch

Try this:

Metacello new
  baseline: 'FileTree';
  repository: 'github://npasserini/pharo-git:unexistent_branch';
  onConflict: [:ex | ex allow];
  load: 'Git'.

Repeated code between incomming and outgoing commits.

Improve refreshing of IcePackageChangeSet

Currently it fogets all elmenents which probably is not efficient.

Remove "extension methods" from the changes tree?

Maybe we could put all classes at the same level and use different icons for them.

Allow for HTTPS URLs

Avoid looking into Pharo50/Pharo60 repositories while commiting.

Run tests agains using a "remote repo" stored locally

Cloning a github repo in the tests is slow and also makes the tests impossible to run for someone not having access rights to the test repository.

IceWorkingCopyDiff should detect new packages when refreshed.

Currently it does not re-read the directories, nor have another strategy to refresh the set of packages, the first list of packages is maintained (yet its children are refreshed).

IceSynchronizer error after renaming a class

Support renaming of packages.

It would be really nice to do a git mv to avoid loosing history.

Refactor changes analysis

There are some types MCDefinition (specifically: MCOrganizationDefinition, which arises when you create or remove a Tag/Category) that contain no package information, but originally we obtained it from a package, we should refactor the way we compute changes to not loose the package association in the first moment.

This enhancement could become unnecessary if we change the underlying changes model.

Packages of a git repo should be updated when the branch changes

Changing branch or version of the repository could change the packages known in that repository, so we should update the package list.

Extension methods are not shown in changes tree

Add "make writable" functionality

Classes in new packages are not shown in the tree

This is because we create the tree looking at the packages that are already in the repository.

Support class renames