OBI README
Object builder for i (OBI) is an automatic build tool.
Notice:
Currently only the Beta version is available.
Final release will be available soon.
Features
Individual source lists with source descriptions

Check for changes
It checks all sources which have changed since last compilie.
The hash value of the source will be used to check if it has changed.
Check for dependencies
All objects which depend on the changed source will also be compiled (in correct order)
E.g. if a table or view has changed, all objects which use them will be compiled too

Compile in correct order
Tables before programs etc. based on the dependency list
See which objects has been compiled and their details
- Command
- joblog
- spool file
- error output

Requirements
The concept
The idea is to work with your sources locally on your PC.
Only for compile process, sources will be synchronised to the IFS.
Because you work locally, you need to sync your changes with other developers.
--> This is where git came in.

Following steps you need to do
First start
On your PC create an empty project folder
In vscode open that folder
Switch to the OBI view
You will see the welcome screen.
Here you can initialize the project with OBI
This creates a new folder .obi including some initial config files
Then OBI opens the config where you need to define some mandatory settings (server, user credentials, ifs locations, ...)
Project configuration contains settings shared with all team members
The User configuration area overwrites the Project configuration with the users specific settings (like SSH user & password, ...).
When you finished configuration, save it and your project gets reloaded automatically.
Now, OBI opens finally containing an sample source in the Source Filters area

Check if it works with Show changes
In the Summary you see a list of sources, ready to compile.
In the Details section you see the build order and it's build commands.
Run Build
2 ways go to:
- In the
Summary click on Run build
- Open the source you need to build and click on the
Run build button:

On your IBM i
Clone OBI from GitHub somewhere in the IFS and run the setup script.
git clone https://github.com/andreas-prouza/obi /ifs/path/obi
cd /ifs/path/obi
./setup.sh
(Copy the path in your project config)
Start migrating your source to OBI
GIT
If you are working in a Team you should use git
- Create a git repository (on your IBM i, gitlab, github, gitea, ...)
- Add the project folder to this git repository
- Clone the git repo on your PC
Copy source to IFS
Get your Sources to IFS (to your project folder)
You can use my RPG program to get this job done:
https://github.com/andreas-prouza/ibm-i-build-obi/blob/main/src/prouzalib/qrpglesrc/cpysrc2ifs.sqlrpgle.pgm
Reset the compiled object list
OBI can check which sources have changed and need to be built.
Therefore, a hash value is stored for each source.
From now, the Show changes action only shows changed sources.
When you are motivated, you can create a dependency list.
With a dependency list OBI creates the correct build order and includes all dependend objects. (E.g. for SRVPGM, files, ...)
(See dependency list)
Sync all changes to your git repo
If no OBI config could be found, you will see the welcome screen:
Happy ever after!
| |